diff --git a/README.md b/README.md index 1232ce9..420165b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -This is pysphereproj +# PySphereProj +This is a simple package made of 3d interpolators (CIC based) and 3d to healpix projector. + +Everything is contained in the package `sphereproj`. + +Here is a short example for spherical projection: + +```python + +import sphereproj +import numpy as np + +N = 256 +Nside=128 +rho = np.random.randn(N,N,N) + +result = sphereproj.spherical_projection(Nside, density, 0, 128, integrator_id=1) +# min_distance, max_distance, progress=1, integrator_id=0, shifter=None, booster=-1) + + +``` diff --git a/pyproject.toml b/pyproject.toml index 829160c..e7766b7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -version = "0.0.2" +version = "1.0.0" requires-python = ">= 3.8" name = "pysphereproj" dependencies = [ @@ -68,10 +68,9 @@ env = "GIT_COMMIT_AUTHOR" default = "semantic-release " [tool.semantic_release.commit_parser_options] -allowed_tags = ["major","build", "chore", "ci", "docs", "feat", "fix", "perf", "style", "refactor", "test"] +allowed_tags = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "style", "refactor", "test"] minor_tags = ["feat"] patch_tags = ["fix", "perf"] -major_tags = ["major"] default_bump_level = 0 [tool.semantic_release.remote] diff --git a/src/sphereproj/__init__.py b/src/sphereproj/__init__.py index 249720a..2cf1ac8 100644 --- a/src/sphereproj/__init__.py +++ b/src/sphereproj/__init__.py @@ -1,3 +1,3 @@ from ._project import spherical_projection, project_cic, interp3d -__version__ = "1.0" +__version__ = "1.0.0"