pycg-dtn 0.1.0__tar.gz

pycg_dtn-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Test
+        # Network tests download kernels from NAIF; kept out of the matrix so a
+        # NAIF outage cannot fail every job.
+        run: pytest -m "not network" -q
+
+  network-test:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - name: Verify kernel registry against NAIF
+        run: pytest -m network -q

pycg_dtn-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+# SPICE kernels -- large binaries, fetched on demand from NAIF
+kernels/
+*.bsp
+*.tls
+*.tpc
+*.part
+
+# generated contact plans
+out/
+contactGraph.csv
+contactGraph.json
+summary.json
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# tooling
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+
+# editors / os
+.vscode/
+.idea/
+.DS_Store

pycg_dtn-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to PyCG-DTN
+
+Thanks for your interest. Bug reports, kernel-registry updates and new geometry
+features are all welcome.
+
+## Getting set up
+
+```bash
+git clone https://github.com/shaanzie/pycg-dtn.git
+cd pycg-dtn
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Running the tests
+
+Most tests are pure logic and run in well under a second:
+
+```bash
+pytest -m "not network"
+```
+
+Tests marked `network` download kernels from NAIF and are slower. Run them before
+opening a PR that touches `kernels.py`:
+
+```bash
+pytest -m network
+```
+
+## Pull requests
+
+- Keep the public API in the existing `PascalCase` style (`AddCelestial`,
+  `GetLinkBudget`, `GenerateContactGraph`); internal helpers stay `snake_case`.
+- New configuration values get a `Get*`/`Set*` pair with validation, and go into
+  the relevant `AsDict()` so they land in output metadata.
+- Add a test that would have failed before your change.
+- Cite a source in a comment for any physical constant or model parameter.
+
+## License
+
+By contributing you agree that your contributions are licensed under the
+GNU General Public License v3.0 or later, the same terms as the project.