Skip to content

Commit

Permalink
Somehow lost this...
Browse files Browse the repository at this point in the history
  • Loading branch information
kb1dds committed May 2, 2017
1 parent e63d0a8 commit 68cd895
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,18 @@
Welcome to PySheaf's documentation!
===================================

The PySheaf library is an experimental platform for computational and applied sheaf theory. Have a look at the latest version at the PySheaf GitHub repository: `<https://github.com/kb1dds/pysheaf>`_

Sheaves are managed by subclassing from :py:class:`CellComplex`, which is a little awkward as :py:class:`SheafCell` is subclassed from :py:class:`Cell`, etc. However, the idea is that everything that can be done to the base space of a sheaf is inherited from its underlying :py:class:`CellComplex` structure.

Sections of sheaves have their own :py:class:`Section` class. Truly, the data structure does not self-check for consistency, so really they are more of an "assignment" or "serration" than a section. However, they do know how to extend themselves.

.. toctree::
:maxdepth: 2
:caption: Contents:

intro
install
cellcomplexes
sheaves
sections
Expand Down

0 comments on commit 68cd895

Please sign in to comment.