updates docs

.github/workflows/CI.yml

@@ -42,4 +42,4 @@ jobs:
       uses: codecov/[email protected]
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        slug: jmbhughes/overlappogram
+        slug: eccco-mission/overlappogram

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build -s
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -8,12 +8,15 @@
 Overlappogram is a Python package for inverting overlappogram observations of the Sun,
 for examples MaGIXS, CubIXSS, or ECCCO observations.
 
+# Install
+
+`pip install overlappogram`
 
 ## How to Use
 
 `overlappogram` comes with an executable main that you can run:
 
-`python -m overlappogram ./path/to/config.toml`
+`unfold ./path/to/config.toml`
 
 The `config.toml` file should be structured similar to the [example_config.toml](example_config.toml).
 
@@ -25,8 +28,6 @@ We prefer this over email so that other users can benefit from your questions.
 
 ## Cite
 
-## Code of Conduct
-
 ## Contributors
 
 The initial version of `overlappogram` was written by Dyana Beabout.

docs/conf.py

@@ -31,7 +31,7 @@
     "icon_links": [
         {
             "name": "GitHub",
-            "url": "https://github.com/jmbhughes/overlappogram",
+            "url": "https://github.com/eccco-mission/overlappogram",
             "icon": "fa-brands fa-github",
             "type": "fontawesome",
         }
@@ -41,7 +41,7 @@
 }
 html_context = {
     # "github_url": "https://github.com", # or your GitHub Enterprise site
-    "github_user": "jmbhughes",
+    "github_user": "eccco-mission",
     "github_repo": "overlappogram",
     "github_version": "main",
     "doc_path": "docs/",

example_config.toml

@@ -28,5 +28,5 @@ selection = 'cyclic'
 
 [execution]
 num_threads = 32
-mode_switch_thread_count = 0
+mode_switch_thread_count = 0  # only used in hybrid mode
 mode = "row"

overlappogram/inversion.py

@@ -249,7 +249,7 @@ def invert(
         rho,
         num_threads: int = 1,
         mode_switch_thread_count: int = 0,
-            mode: InversionMode = InversionMode.HYBRID,
+        mode: InversionMode = InversionMode.HYBRID,
     ) -> (NDCube, NDCube, np.ndarray, list[int]):
         self._initialize_with_overlappogram(overlappogram)
 

pyproject.toml

@@ -45,9 +45,9 @@ unfold = "overlappogram.cli:unfold"
 [project.urls]
 Homepage = "https://example.com"
 Documentation = "https://readthedocs.org"
-Repository = "https://github.com/jmbhughes/overlappogram.git"
-"Bug Tracker" = "https://github.com/jmbhughes/overlappogram/issues"
-Changelog = "https://github.com/jmbhughes/overlappogram/blob/main/CHANGELOG.md"
+Repository = "https://github.com/eccco-mission/overlappogram.git"
+"Bug Tracker" = "https://github.com/eccco-mission/overlappogram/issues"
+Changelog = "https://github.com/eccco-mission/overlappogram/blob/main/CHANGELOG.md"
 
 [tool.setuptools]
 packages = ["overlappogram"]