65 lines
1.3 KiB
ReStructuredText
65 lines
1.3 KiB
ReStructuredText
==============
|
|
Vector Bundles
|
|
==============
|
|
|
|
This is a `SageMath <http://www.sagemath.org>`_ implementing algorithms for creating and
|
|
manipulating Vector Bundles over algebraic curves on finite field. All manipulations are
|
|
done using algebra on function fields.
|
|
|
|
Installation
|
|
------------
|
|
|
|
Local install from source
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Download the source from the git repository::
|
|
|
|
$ git clone https://git.disroot.org/montessiel/vector-bundles-sagemath.git
|
|
|
|
Change to the root directory and run::
|
|
|
|
$ sage -pip install --upgrade --no-index -v .
|
|
|
|
For convenience this package contains a `makefile <makefile>`_ with this
|
|
and other often used commands. Should you wish too, you can use the
|
|
shorthand::
|
|
|
|
$ make install
|
|
|
|
Usage
|
|
-----
|
|
|
|
|
|
Once the package is installed, you can use it in Sage with::
|
|
|
|
sage: from vector_bundle import *
|
|
|
|
See also the `demo notebook <demo.ipynb>`_ and the documentation.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
The documentation of the package can be generated using Sage's
|
|
``Sphinx`` installation::
|
|
|
|
$ cd docs
|
|
$ sage -sh -c "make html"
|
|
|
|
Shorthand::
|
|
|
|
$ make doc
|
|
|
|
TEST
|
|
----
|
|
|
|
To run the test suite of the package, simply run the command::
|
|
|
|
$make test
|
|
|
|
from the root of the repository.
|
|
|
|
CONTACT
|
|
-------
|
|
|
|
Mickaël Montessinos: mickael.montessinos@mif.vu.lt
|