Merge pull request #113 from RamanujanMachine/feature/deployment

Feature/deployment

Author: RotemKalisch

.github/workflows/python-package.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.12"]
+        python-version: ["3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3
@@ -29,7 +29,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install flake8 pytest
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install .[dev]
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names

.gitignore

@@ -4,3 +4,5 @@
 *.egg-info
 build
 __pycache__
+dist/
+build/

CITATION.cff

@@ -1,18 +1,22 @@
-# This CITATION.cff file was generated with cffinit.
-# Visit https://bit.ly/cffinit to generate yours today!
-
 cff-version: 1.2.0
-title: Ramanujan Tools
+title: ramanujantools
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
 type: software
+version: 0.0.1
+date-released: 2025-06-20
 authors:
-  - name: Ramanujan Machine Research Group
+  - name: Ramanujan Machine Group
+    affiliation: Technion – Israel Institute of Technology
 repository-code: 'https://github.com/RamanujanMachine/ramanujantools'
 url: 'https://www.ramanujanmachine.com/'
-abstract: Tools used to study polynomial continued fractions and conservative matrix fields.
+abstract: Official symbolic and numeric research tools developed by the Ramanujan Machine team
 keywords:
   - Ramanujan Machine
-  - Polynomial continued fractions
-  - Conservative matrix fields
+  - polynomial continued fractions
+  - conservative matrix fields
+  - diophantine approximations
+  - linear recurrences
+  - p-recursive sequences
+  - irrationality measure

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Ramanujan Machine Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,32 +1,30 @@
-# Ramanujan Tools
+# ramanujantools
 
-The official and up-to-date research tools of the Ramanujan Machine research group.
+Official symbolic and numeric research tools developed by the Ramanujan Machine research group.
+
+## About
+
+`ramanujantools` is a research focused python library that provides symbolic and numeric tools for exploring Polynomial Continued Fractions (PCFs), Linear Recurrences and Conservative Matrix Fields (CMFs). These can be used to discover new conjectures converging sequences to constants of interest such as *e*, *π*, *G* (Catalan's constant), *γ* (Euler's constant), *δ* (Gompertz constant) and integer values of the Riemann Zeta function *ζ(s)*.
 
 ## Installation
 
-```commandline
-pip install git+https://github.com/RamanujanMachine/ramanujantools.git
+```bash
+pip install ramanujantools
 ```
 
-## The code
+## Contributing
+Contributions are welcome! Please open issues or pull requests on GitHub.
 
-### Overview
+## Citation
 
-The most relevant pieces of code of this library are:
+If you use this package in your research, please cite it using the metadata in [`CITATION.cff`](./CITATION.cff), or refer to the citation instructions on our [GitHub repository](https://github.com/RamanujanMachine/ramanujantools).
 
-- `Matrix` which inherits `sympy.Matrix` and adds the walk method,
-  which allows us to walk alongside a trajectory
-- `PCF` (Polynomial Continued Fraction) which can calculate the limit of a PCF
-- `CMF` (Conservative Matrix Field) which is made of multiple instances of `Matrix`
-  and methods such as walk and limit
-- `FFbar` which contains the conditions and logic for ffbar construction of CMFs
-- The `known_cmfs` module which contains most of our known CMFs
-- CMF to PCF transformation functions
+## License
 
-### Example: calculating the limit of zeta3 CMF alongside the diagonal
+This project is licensed under the terms of the [MIT License](./LICENSE).
 
-```python
-from ramanujantools.cmf import known_cmfs
+## Links
 
-known_cmfs.zeta3().limit([1,1], 100).as_float()
-```
+- Website: [https://www.ramanujanmachine.com](https://www.ramanujanmachine.com)
+- Repository: [https://github.com/RamanujanMachine/ramanujantools](https://github.com/RamanujanMachine/ramanujantools)
+- Citation file: [`CITATION.cff`](./CITATION.cff)

pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ramanujantools"
+version = "0.0.1"
+description = "Official symbolic and numeric research tools developed by the Ramanujan Machine team"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+
+authors = [
+  { name = "Ramanujan Machine Group", email = "ramanujan.machine@gmail.com" }
+]
+
+dependencies = [
+    "tqdm>=4.65.0",
+    "multimethod>=1.10",
+    "numpy>=2.0.0",
+    "mpmath>=1.3.0",
+    "sympy>=1.11.0",
+    "gmpy2>=2.2.0",
+    "python-flint>=0.7.0",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.2.0"]
+
+[tool.pytest.ini_options]
+python_files = "*_test.py"
+testpaths = ["ramanujantools"]
+[project.urls]
+
+Homepage = "https://www.ramanujanmachine.com/"
+Repository = "https://github.com/RamanujanMachine/ramanujantools"
+

ramanujantools/__init__.py

@@ -5,8 +5,7 @@
 from .linear_recurrence import LinearRecurrence
 from .simplify_object import simplify
 
-from . import pcf
-from . import cmf
+__version__ = "0.0.1"
 
 __all__ = [
     "Position",
@@ -15,6 +14,4 @@
     "GenericPolynomial",
     "LinearRecurrence",
     "simplify",
-    "pcf",
-    "cmf",
 ]

ramanujantools/cmf/__init__.py

@@ -1,5 +1,3 @@
 from .cmf import CMF
 
-from . import ffbar, known_cmfs
-
-__all__ = ["CMF", "ffbar", "known_cmfs"]
+__all__ = ["CMF"]

ramanujantools/cmf/cmf_test.py

@@ -6,6 +6,8 @@
 from ramanujantools import Position, Matrix, simplify
 from ramanujantools.cmf import CMF, known_cmfs
 
+c0, c1, c2, c3 = sp.symbols("c:4")
+
 
 def test_N():
     cmf = known_cmfs.hypergeometric_derived_2F1()
@@ -40,15 +42,15 @@ def test_assert_conserving():
 def test_symbols():
     cmf = known_cmfs.cmf1()
     expected_axes = {x, y}
-    expected_parameters = {known_cmfs.c0, known_cmfs.c1, known_cmfs.c2, known_cmfs.c3}
+    expected_parameters = {c0, c1, c2, c3}
     assert expected_axes == cmf.axes()
     assert expected_parameters == cmf.parameters()
     assert set().union(expected_axes, expected_parameters) == cmf.free_symbols()
 
 
 def test_subs():
     cmf = known_cmfs.var_root_cmf()
-    substitution = Position({known_cmfs.c0: 1, known_cmfs.c1: 2 * known_cmfs.c1 - 3})
+    substitution = Position({c0: 1, c1: 2 * c1 - 3})
     assert cmf.subs(substitution) == CMF(
         {axis: matrix.subs(substitution) for axis, matrix in cmf.matrices.items()}
     )

ramanujantools/cmf/ffbar/ffbar_test.py

@@ -1,10 +1,12 @@
+import sympy as sp
 from sympy.abc import x, y
 
 from ramanujantools import Matrix, Position
 from ramanujantools.cmf import CMF, known_cmfs
-from ramanujantools.cmf.known_cmfs import c0, c1, c2, c3
 from ramanujantools.cmf.ffbar import FFbar
 
+c0, c1, c2, c3 = sp.symbols("c:4")
+
 
 def test_linear_condition():
     assert FFbar.linear_condition(x + y, x - y) == 0