Initial Release v1.0.0

.gitignore

@@ -0,0 +1,11 @@
+.venv
+.idea
+*.egg-info
+*.pyc
+temp
+dist
+build
+.pytest_cache
+.DS_Store
+docs/_build
+.ipynb_checkpoints

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  apt_packages:
+    - libproj-dev
+    - libgeos-dev
+    - graphviz
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements.txt

Manifest.in

@@ -0,0 +1,2 @@
+include PYPI-README.rst
+include license.txt

PYPI-README.rst

@@ -0,0 +1,25 @@
+=========
+GDT-HETE2
+=========
+
+The GDT-HETE2 is an extension to Gamma-ray Data Tools that adds functions specific to the hete2 mission.
+
+Normal Installation
+-------------------
+
+If you don't plan to contribute code to the project, the recommended install method is installing from PyPI using:
+
+.. code-block:: sh
+
+   pip install astro-gdt-hete2
+   gdt-data init
+
+The ``gdt-data init`` is required to initialize the library after installation of astro-gdt. You do not need to
+perform the initialization again if astro-gdt was already installed and initialized.  There is no harm in running
+it again "just in case".
+
+Contributing Code or Documentation
+----------------------------------
+
+If you plan to help with the development or documentation of astro-gdt-hete2, then please visit our github site at
+https://github.com/USRA-STI/gdt-hete2.

README.rst

@@ -0,0 +1,63 @@
+=========
+GDT-HETE2
+=========
+
+The GDT-HETE2 is an extension to Gamma-ray Data Tools that adds functions specific to the hete2 mission.
+
+Normal Installation
+-------------------
+
+If you don't plan to contribute code to the project, the recommended install method is installing from PyPI using:
+
+.. code-block:: sh
+
+   pip install astro-gdt-hete2
+   gdt-data init
+
+The ``gdt-data init`` is required to initialize the library after installation of astro-gdt. You do not need to
+perform the initialization again if astro-gdt was already installed and initialized.  There is no harm in running
+it again "just in case".
+
+
+Writing Extensions using Namespace Packaging
+--------------------------------------------
+This is an extension to astro-gdt and should should contain a directory 'gdt' with a subdirectory 'missions' which will hold the extension code
+in a package directory named after the mission.
+
+For example, GDT-HETE2 has the following directory layout::
+
+  .
+  ├── config
+  ├── dist
+  ├── docs
+  ├── src
+  │   └── gdt
+  │      └── missions
+  │          └── hete2
+  │              └── __init__.py
+  └── tests
+    └── missions
+        └── hete2
+
+
+Since GDT-HETE2 uses namespace packaging, both ``src/gdt`` and  ``src/gdt/missions`` do not contain a file named
+``__init__.py``. This is because they are Namespace packages.
+
+Notice that directory ``src/gdt/mission/hete2`` contains an `__init__.py` file
+signalling to Python that those directories are regular packages.
+
+You can learn more about Namespace packages by reading `PEP-420 <https://peps.python.org/pep-0420/>`_.
+
+Helping with Documentation
+--------------------------
+
+You can contribute additions and changes to the documentation. In order to use sphinx to compile the documentation
+source files, we recommend that you install the packages contained within ``requirments.txt``.
+
+To compile the documentation, use the following commands:
+
+.. code-block:: sh
+
+   cd $PROJ_ROOT/docs
+   make html
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)