Merge pull request #9 from teob97/master

New tests and documentation @teob97 Great thanks!
yusuke-takase · Sep 15, 2024 · 78d6aa3 · 78d6aa3
2 parents c5245a2 + 409f84f
commit 78d6aa3
Show file tree

Hide file tree

Showing 82 changed files with 19,470 additions and 1,270,876 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -53,10 +53,12 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
+      - name: Setup pandoc
+        uses: nikeee/setup-pandoc@v1
+
       - name: Build Sphinx
         run: |
           cd docs
-          poetry run sphinx-apidoc -f -o . ../
           poetry run make html
 
       - name: Setup Pages
@@ -65,7 +67,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: "./docs/_build/html/"
+          path: "./docs/build/html/"
 
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,9 @@ grasp2alm/__pycache__/
 dist/
 test/__pycache__
 .pytest_cache/
+.vscode/
+.DS_Store
+test/.DS_Store
+docs/build
+.venv/
+notebooks/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+# HEAD
+
+- Added new tests [[#1](https://github.com/teob97/grasp2alm/pull/1)]
+- Added a complete doumentation [[#4](https://github.com/teob97/grasp2alm/pull/4)]
+
+# Version 0.1.0
+
+- First release of the code
diff --git a/README.md b/README.md
@@ -11,9 +11,9 @@
 ![PyPI - License](https://img.shields.io/pypi/l/grasp2alm)
 
 This package supports the conversion from beam data calculated using [GRASP](https://www.ticra.com/software/grasp/) for CMB experiments to spherical harmonic coefficients ($a_{\ell m}$) based on the [HEALPix](https://healpix.sourceforge.io/) framework.
-The code is designed based on [Beam](https://github.com/zonca/planck-levelS/tree/master/Beam), which is part of [LevelS](https://github.com/zonca/planck-levelS), the pipleline of the Planck experiment.
+The code is designed based on [Beam](https://github.com/zonca/planck-levelS/tree/master/Beam), which is part of [LevelS](https://github.com/zonca/planck-levelS), the pipeline of the Planck experiment.
 
-## Instllation
+## Installation
 
 ```
 pip install grasp2alm

diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -18,6 +18,3 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-html: Makefile
-	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "docs" $(SPHINXOPTS) $(O)
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/grasp2alm.doctree b/docs/_build/doctrees/grasp2alm.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
diff --git a/docs/_build/html/_modules/grasp2alm/beam2alm.html b/docs/_build/html/_modules/grasp2alm/beam2alm.html
diff --git a/docs/_build/html/_modules/grasp2alm/beam_cut.html b/docs/_build/html/_modules/grasp2alm/beam_cut.html
diff --git a/docs/_build/html/_modules/grasp2alm/beam_grid.html b/docs/_build/html/_modules/grasp2alm/beam_grid.html
diff --git a/docs/_build/html/_modules/grasp2alm/beam_map.html b/docs/_build/html/_modules/grasp2alm/beam_map.html