hilbert-modular-group 0.1.0__tar.gz → 0.1.2__tar.gz

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/Dockerfile

@@ -1,14 +1,14 @@
 ARG REMOTE_SRC=1
 ARG GIT_BRANCH=develop
 
-FROM sagemath/sagemath:9.5 as base
+FROM --platform=linux/amd64 sagemath/sagemath:10.3 as base
 RUN sudo apt-get update
 RUN sudo apt-get -y install git
 
 FROM base as use-git-1
 RUN git clone https://github.com/fredstro/hilbertmodgroup.git
 WORKDIR "hilbertmodgroup"
-RUN git config pull.rebase false && git checkout $GIT_BRANCH
+RUN git config pull.rebase false && git checkout ${GIT_BRANCH}
 
 FROM base as use-git-0
 ARG GIT_BRANCH=''

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/Makefile

@@ -45,29 +45,29 @@ examples:
                             --NotebookApp.browser=x-www-browser
 
 tox:
-	sage -pip install tox
-	sage --python -m tox src -c tox.ini -e $(TOX_ARGS)
+	sage -pip install tox meson
+	sage --python -m tox -c tox.ini -e $(TOX_ARGS)
 
 docker:
 	docker build --build-arg GIT_BRANCH=$(GIT_BRANCH) --build-arg REMOTE_SRC=$(REMOTE_SRC) -t hilbertmodgroup-$(TAG) .
 
 docker-rebuild:
-	docker build --build-arg GIT_BRANCH=$(GIT_BRANCH) --build-arg REMOTE_SRC=$(REMOTE_SRC) --no-cache -t hilbertmodgroup=$(TAG) .
+	docker build --build-arg GIT_BRANCH=$(GIT_BRANCH) --build-arg REMOTE_SRC=$(REMOTE_SRC) --no-cache -t hilbertmodgroup-$(TAG) .
 
 docker-test: docker
-	docker run -it --init hilbertmodgroup-$(GIT_BRANCH) test
+	docker run --platform linux/amd64 -it -e GIT_BRANCH=$(GIT_BRANCH) --init hilbertmodgroup-$(TAG) test
 
 docker-examples: docker
-	docker run -p $(NBPORT):$(NBPORT) -it -e GIT_BRANCH=$(GIT_BRANCH) -e NBPORT=$(NBPORT) --init hilbertmodgroup-$(TAG) examples $(EXAMPLES_ARGS)
+	docker run --platform linux/amd64 -p $(NBPORT):$(NBPORT) -it -e GIT_BRANCH=$(GIT_BRANCH) -e NBPORT=$(NBPORT) --init hilbertmodgroup-$(TAG) examples $(EXAMPLES_ARGS)
 
 docker-tox: docker
-	docker run -it -e GIT_BRANCH=$(GIT_BRANCH) -e TOX_ARGS=$(TOX_ARGS) --init hilbertmodgroup-$(TAG) tox
+	docker run --platform linux/amd64 -it -e GIT_BRANCH=$(GIT_BRANCH) -e TOX_ARGS=$(TOX_ARGS) --init hilbertmodgroup-$(TAG) tox
 
 docker-shell: docker
-	docker run -it -e GIT_BRANCH=$(GIT_BRANCH) --init hilbertmodgroup-$(TAG) shell
+	docker run --platform linux/amd64 -it -e GIT_BRANCH=$(GIT_BRANCH) --init hilbertmodgroup-$(TAG) shell
 
 docker-sage: docker
-	docker run -it -e GIT_BRANCH=$(GIT_BRANCH) --init hilbertmodgroup-$(TAG) run
+	docker run --platform linux/amd64 -it -e GIT_BRANCH=$(GIT_BRANCH) --init hilbertmodgroup-$(TAG) run
 
 
 clean:

hilbert_modular_group-0.1.2/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.1
+Name: hilbert_modular_group
+Version: 0.1.2
+Summary: Algorithms for Hilbert modular groups
+Home-page: https://github.com/fredstro/hilbertmodgroup
+Author: Fredrik Stromberg
+Author-email: fredrik314@gmail.com
+License: GPL v3+
+Project-URL: Bug Tracker, https://github.com/fredstro/hilbertmodgroup/issues
+Project-URL: Source Code, https://github.com/fredstro/hilbertmodgroup/
+Keywords: "hilbert modular groups,reduction algorithms"
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Cython
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Hilbert Modular Groups
+
+This repository contains a python package `hilbert_modgroup` that implements algorithms 
+for Hilbert modular groups, in particular a reduction algorithm. The implementation is written in Python 
+and is dependent on SageMath.
+
+## Requirements
+- SageMath v9.6+ (https://www.sagemath.org/)
+  (Tested on v9.6, v9.7, v10.0 and v10.2)
+
+## Installation
+### Using sage pip
+This package needs to be installed in the virtual environment provided by SageMath, and it is therefore necessary 
+to run the following command 
+```console
+$ sage -pip install --no-build-isolation hilbert-modular-group
+```
+**Note**: The `--no-build-isolation` is necessary as the compiler needs access 
+to certain library files from the sage installation and SageMath itself is 
+too large to be required as a build dependency. 
+As an alternative to this flag you can also specify the environment variable 
+SAGE_LIB explicitly.
+
+### From git source
+If the SageMath executable `sage` is in the current path you can install from source using the Makefile
+
+```console
+$ git clone https://github.com/fredstro/hilbertmodgroup.git
+$ cd hilbertmodgrup
+$ make install
+```
+
+### Docker
+If you do not have SageMath installed, but you have docker you can use install this package
+in a docker container built and executed using e.g. `make docker-sage` or `make docker-examples`
+
+
+## Usage
+The package can be imported and used as any other package. 
+For example, to find the reduction of the point given by [1+i,1+i] in H^2 
+with respect to the Hilbert modular group of Q joint by square-root of 5 write: 
+
+```
+sage: from hilbert_modgroup.all import *
+sage: H1=HilbertModularGroup(5)
+sage: P1=HilbertPullback(H1)
+sage: z = UpperHalfPlaneProductElement([1+I,1+I])
+sage: P1.reduce(z)
+[1.00000000000000*I, 1.00000000000000*I]
+sage: z = UpperHalfPlaneProductElement([0.25+I/2,1+I])
+sage: P1.reduce(z) # abs tol 1e-10
+[0.694427190999916 + 0.611145618000168*I, -0.309016994374947 + 1.30901699437495*I]
+sage: P1.reduce(z, return_map=True)[1]
+[-1/2*a + 1/2  1/2*a + 1/2]
+[-1/2*a + 1/2            0]
+
+```
+For more examples see the embedded doctests (search for `EXAMPLES`) as well as
+the `/examples` directory which contains Jupyter notebook with more extensive 
+examples corresponding to the paper
+"Reduction Algorithms for Hilbert Modular Groups" by F. Stromberg. (Reference to appear)
+
+## Examples
+
+The directory `/examples` contains Jupyter notebooks with example code to illustrate the interface and functionality of this package. 
+You can either open them manually from SageMath or run one of the following commands:
+`make examples`
+`make docker-examples`
+which will start up a Jupyter notebook server from sagemath either locally or in a docker container. 
+
+## Community Guidelines
+
+### How to Contribute?
+- Open an issue on GitHub and create a pull / merge request against the `develop` branch.
+### How to report an issue or a problem? 
+- First check if the issue is resolved in the `develop` branch. If not, open an issue on GitHub. 
+### How to seek help and support?
+- Contact the maintainer, Fredrik Stromberg, at: fredrik314@gmail.com (alternatively at fredrik.stromberg@nottingham.ac.uk)
+
+## Development and testing
+
+The make file `Makefile` contains a number of useful commands that you can run using 
+```console
+$ make <command>
+```
+The following commands are run in your local SagMath environment:
+1. `build` -- builds the package in place (sometimes useful for development).
+2. `sdist` -- create a source distribution in /sdist (can be installed using `sage -pip install sdist/<dist name>`)
+3. `install` -- build and install the package in the currently active sage environment
+4. `clean` -- remove all build and temporary files
+5. `test` -- run sage's doctests (same as `sage -t src/*`)
+6. `examples` -- run a Jupyter notebook with the SageMath kernel initialised at the `/examples` directory.
+7. `tox` -- run `sage -tox` with all environments: `doctest`, `coverage`, `pycodestyle`, `relint`, `codespell`
+   Note: If your local SageMath installation does not contain tox this will run `sage -pip install tox`.
+
+The following commands are run in an isolated docker container 
+and requires docker to be installed and running:
+1. `docker` -- build a docker container with the tag `hilbertmodgroup-{GIT_BRANCH}`
+2. `docker-rebuild` -- rebuild the docker container without cache
+3. `docker-test` -- run SageMath's doctests in the docker container
+4. `docker-examples` -- run a Jupyter notebook with the SageMath kernel initialised at the `/examples` directory 
+  and exposing the notebook at http://127.0.0.1:8888. The port used can be modified by 
+5. `docker-tox` -- run tox with all environments: `doctest`, `coverage`, `pycodestyle`, `relint`, `codespell`. 
+6. `docker-shell` -- run a shell in a docker container
+7. `docker-sage` -- run a sage interactive shell in a docker container
+
+The following command-line parameters are available 
+- `NBPORT` -- set the port of the notebook for `examples` and `docker-examples`  (default is 8888)
+- `TOX_ARGS` -- can be used to select one or more of the tox environments (default is all)
+- `REMOTE_SRC` -- set to 0 if you want to use the local source instead of pulling from gitHub (default 1)
+- `GIT_BRANCH` -- the branch to pull from gitHub (used if REMOTE_SRC=1)
+
+### Example usage
+Run tox coverage on the branch `main` from gitHub:
+
+`make docker-tox REMOTE_SRC=1 GIT_BRANCH=main TOX_ARGS=coverage`
+
+Run doctests on the local source with local version of sage:
+
+`make tox TOX_ARGS=doctest`
+
+Run relint on the local source with docker version of sage:
+
+`make docker-tox REMOTE_SRC=0 TOX_ARGS=relint`
+
+## Development
+
+### GitHub Workflow
+
+- There are two long-lived branches `main` and `develop`.
+- The `develop` branch is used for development and can contain new / experimental features.  
+- Pull-requests should be based on `develop`.
+- Releases should be based on `main`.
+- The `main` branch should always be as stable and functional as possible. In particular, merges should always happen from `develop` into `main`. 
+- Git-Flow is enabled (and encouraged) with feature branches based on `develop` and hotfixes based on `main`. 
+
+### GitHub Actions
+
+Each commit is tested and checked using gitHub actions with tox running:
+- `doctest` -- run all doctests
+- `coverage` -- ensure that all functions and classes are documented 
+- `pycodestyle-minimal` -- ensure PEP8 style guide is followed (except we allow max line length 99)
+- `relint` -- relint against some patterns taken from the SageMath source (config file .relint.yaml)
+- `codespell` -- spellchecker
+
+To make sure that your commit passes all tests you should `make tox` or `make docker-tox REMOTE_SRC=0` on the command line.
+
+### Versions
+
+Versioning of this project is managed by setuptools_scm.
+To bump the version create a git tag `x.y.z` and the file 
+ `src/hilbert_modgroup/version.py` will then be automatically updated to contain 
+```
+version = 'x.y.z.???'
+version_tuple = (x, y, z, '???')
+```
+where ??? depends on the state of the current directory. 
+If you are creating a new version to release the source directory should be clean.
+
+### PyPi
+
+To upload new versions to PyPi: 
+1. `make sdist` -- creates a source distribution `dist/hilbert_modular_group-x.y.z`
+2. `twine check dist/hilbert_modular_group-x.y.z`
+3. `twine upload --repository pypi dist/hilbert_modular_group-z.y.z`
+
+## References:
+
+- [![DOI](https://joss.theoj.org/papers/10.21105/joss.03996/status.svg)](https://doi.org/10.21105/joss.03996)

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/README.md

@@ -5,7 +5,8 @@ for Hilbert modular groups, in particular a reduction algorithm. The implementat
 and is dependent on SageMath.
 
 ## Requirements
-- SageMath v9.4+ (https://www.sagemath.org/)
+- SageMath v9.6+ (https://www.sagemath.org/)
+  (Tested on v9.6, v9.7, v10.0 and v10.2)
 
 ## Installation
 ### Using sage pip
@@ -162,3 +163,7 @@ To upload new versions to PyPi:
 1. `make sdist` -- creates a source distribution `dist/hilbert_modular_group-x.y.z`
 2. `twine check dist/hilbert_modular_group-x.y.z`
 3. `twine upload --repository pypi dist/hilbert_modular_group-z.y.z`
+
+## References:
+
+- [![DOI](https://joss.theoj.org/papers/10.21105/joss.03996/status.svg)](https://doi.org/10.21105/joss.03996)

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/entrypoint.sh

@@ -20,7 +20,7 @@ case $1 in
     tox)
       echo "Docker container running tox with $TOX_ARGS"
       sage -pip install tox
-      sage -python -m tox -c tox.ini src -e $TOX_ARGS
+      sage -python -m tox -c tox.ini -e $TOX_ARGS
       ;;
     examples)
       echo "Docker container with Jupyter Notebook interface to run example notebooks."

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/examples/ExamplesK1.ipynb

@@ -240,7 +240,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,K1.ideal(1).integral_basis(),action='show',**norm_args)"
+    "plot_polygon(p,K1.fractional_ideal(1).integral_basis(),action='show',**norm_args)"
    ]
   },
   {
@@ -256,7 +256,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,K1.ideal(1).integral_basis(),action='save',filename='K1.z1.domain1.pgf',**norm_args)"
+    "plot_polygon(p,K1.fractional_ideal(1).integral_basis(),action='save',filename='K1.z1.domain1.pgf',**norm_args)"
    ]
   },
   {
@@ -461,7 +461,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "basis=K1.ideal(1).integral_basis(); basis"
+    "basis=K1.fractional_ideal(1).integral_basis(); basis"
    ]
   },
   {
@@ -490,7 +490,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p1,K1.ideal(1).integral_basis(),action='save',filename='K1.z2.domain1.pgf',xmin=-3,xmax=3,ymin=-3,ymax=3,\n",
+    "plot_polygon(p1,K1.fractional_ideal(1).integral_basis(),action='save',filename='K1.z2.domain1.pgf',xmin=-3,xmax=3,ymin=-3,ymax=3,\n",
     "             ticks=[2,2],**norm_args)"
    ]
   },
@@ -550,7 +550,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "SageMath 9.5",
+   "display_name": "SageMath 10.0",
    "language": "sage",
    "name": "sagemath"
   },
@@ -564,7 +564,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.2"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/examples/ExamplesK2.ipynb

@@ -252,7 +252,7 @@
    "outputs": [],
    "source": [
     "p=P2._candidate_integers_sigma(z,domain='preimage',return_polyhedron=True)\n",
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='show',xmin=-5,xmax=5,ymin=-4.5,ymax=4.5,**norm_args)"
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='show',xmin=-5,xmax=5,ymin=-4.5,ymax=4.5,**norm_args)"
    ]
   },
   {
@@ -261,7 +261,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='save',xmin=-5,xmax=5,ymin=-4.5,ymax=4.5,filename='K2.z1.domain1.pgf',**norm_args)"
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='save',xmin=-5,xmax=5,ymin=-4.5,ymax=4.5,filename='K2.z1.domain1.pgf',**norm_args)"
    ]
   },
   {
@@ -395,8 +395,8 @@
    "outputs": [],
    "source": [
     "p=P2._candidate_integers_sigma(z,domain='preimage',return_polyhedron=True)\n",
-    "norm_args = {'norm_bound':P2._bound_for_sigma_norm(z,dist=0.5)}\n",
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='show',**norm_args)"
+    "norm_args = {'norm_bound':P2._bound_for_sigma_norm(z,dist=0.5),'xmin':-35,'xmax':35}\n",
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='show',**norm_args)"
    ]
   },
   {
@@ -405,7 +405,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='save',filename='K2.z2.domain1.pgf',**norm_args)"
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='save',filename='K2.z2.domain1.png',**norm_args)"
    ]
   },
   {
@@ -415,8 +415,9 @@
    "outputs": [],
    "source": [
     "p=P2._candidate_integers_sigma(z,domain='polytope',return_polyhedron=True)\n",
-    "norm_args = {'norm_bound':P2._bound_for_sigma_norm(z,dist=0.5),'curve_map':P2.basis_matrix_ideal().inverse(),'norm_plot_factor':1.5}\n",
-    "plot_polygon(p,[1,1],action='show',ymax=4,ymin=-4,**norm_args)"
+    "norm_args = {'norm_bound':P2._bound_for_sigma_norm(z,dist=0.5),'curve_map':P2.basis_matrix_ideal().inverse(),\n",
+    "             'norm_plot_factor':1.5,'ymin':-7,'ymax':7}\n",
+    "plot_polygon(p,[1,1],action='show',**norm_args)"
    ]
   },
   {
@@ -425,7 +426,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,[1,1],action='save',ymax=4,ymin=-4,filename='K2.z2.domain2.pgf',**norm_args)"
+    "plot_polygon(p,[1,1],action='save',filename='K2.z2.domain2.png',**norm_args)"
    ]
   },
   {
@@ -550,7 +551,7 @@
    "source": [
     "p=P2._candidate_integers_sigma(z,domain='preimage',return_polyhedron=True)\n",
     "norm_args = {'norm_bound':P2._bound_for_sigma_norm(z,dist=1.59731464318420)}\n",
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='show',ticks=[5,5],**norm_args)"
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='show',ticks=[5,5],**norm_args)"
    ]
   },
   {
@@ -559,7 +560,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_polygon(p,K2.ideal(1).integral_basis(),action='save',ticks=[5,5],filename='K2.z3.domain1.pgf',**norm_args)"
+    "plot_polygon(p,K2.fractional_ideal(1).integral_basis(),action='save',ticks=[5,5],filename='K2.z3.domain1.pgf',**norm_args)"
    ]
   },
   {
@@ -659,7 +660,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "c.is_Gamma0_equivalent(H2.cusps()[0],K2.ideal(1)) # Not equivalent to infinity"
+    "c.is_Gamma0_equivalent(H2.cusps()[0],K2.fractional_ideal(1)) # Not equivalent to infinity"
    ]
   },
   {
@@ -668,7 +669,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "c.is_Gamma0_equivalent(H2.cusps()[1],K2.ideal(1),True) #Is equivalent to the other cusp."
+    "c.is_Gamma0_equivalent(H2.cusps()[1],K2.fractional_ideal(1),True) #Is equivalent to the other cusp."
    ]
   },
   {
@@ -854,7 +855,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "SageMath 9.5",
+   "display_name": "SageMath 10.0",
    "language": "sage",
    "name": "sagemath"
   },
@@ -868,7 +869,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.2"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/examples/ExamplesK3.ipynb

@@ -490,7 +490,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "SageMath 9.5",
+   "display_name": "SageMath 10.0",
    "language": "sage",
    "name": "sagemath"
   },
@@ -504,7 +504,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.2"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,

{hilbert_modular_group-0.1.0 → hilbert_modular_group-0.1.2}/examples/ExamplesK4.ipynb

@@ -112,7 +112,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "K4.ideal(1).basis()"
+    "K4.fractional_ideal(1).basis()"
    ]
   },
   {
@@ -230,7 +230,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "SageMath 9.5",
+   "display_name": "SageMath 10.0",
    "language": "sage",
    "name": "sagemath"
   },
@@ -244,7 +244,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.2"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,