Compare commits

...

2 Commits

Author SHA1 Message Date
Montessinos Mickael Gerard Bernard b9f4bead1f Added new option for using the package without installation 2024-03-15 12:08:19 +02:00
Montessinos Mickael Gerard Bernard e535dbd1a8 Updated setup.py with URL and new readme file 2024-03-15 11:56:06 +02:00
2 changed files with 26 additions and 6 deletions

View File

@ -7,13 +7,22 @@ valid, but there is no guarantee for the implementation). All manipulations are
done using algebra on function fields. This implements algorithms from
[this work](https://arxiv.org/abs/2403.09449).
This package was developped and tested using Sage version 10.3. There is no
guarantee that it will work with an older version of Sage. For instance,
structural differences in the function_field package of sage prevents
vector_bundle from working with Sage version 9.2 and earlier. Please let me
know wheter vector_bundle works for you if you use a version of Sage between 9.2
and 10.3.
## Installation
### If sage is built 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:
Run the following from the root directory of the cloned repository:
$ sage -pip install --upgrade --no-index -v .
@ -23,6 +32,19 @@ shorthand:
$ make install
### Using the package without installation
If you did not build Sage from sources, you can use this package without
installing it. Download the source using.
$ git clone https://git.disroot.org/montessiel/vector-bundles-sagemath.git
Reun the following from the root directory:
$ sage -python setup.py build_ext --inplace
Add the `vector_bundle` directory to your Python `sys.path`
## Usage
Once the package is installed, you can use it in Sage with:

View File

@ -29,11 +29,9 @@ setup(
name = "vector_bundle",
version = readfile("VERSION").strip(), # the VERSION file is shared with the documentation
description='A sage package implementing vector bundles on algebraic curves using only function fields',
long_description = readfile("README.rst"), # get the long description from the README
# For a Markdown README replace the above line by the following two lines:
# long_description = readfile("README.md"),
# long_description_content_type="text/markdown",
# url='https://github.com/sagemath/sage_sample',
long_description = readfile("README.md"),
long_description_content_type="text/markdown",
url='https://git.disroot.org/montessiel/vector-bundles-sagemath',
author='Mickaël Montessinos',
author_email='mickael.montessinos@mif.vu.lt', # choose a main contact email
license='GPLv2+', # This should be consistent with the LICENCE file