diff --git a/CITATION.cff b/CITATION.cff index 6be81f6..fe0dcf7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -4,8 +4,8 @@ authors: - family-names: Irving given-names: Zackery A. orcid: https://orcid.org/0009-0006-0951-3429 -title: "opticam_new" -version: 0.2.3 +title: "opticam" +version: 0.3.0 identifiers: # - type: doi # value: 10.5281/zenodo.1234 diff --git a/README.md b/README.md index 40d9d6b..7876ffc 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ -# opticam_new +# opticam A Python package for reducing OPTICAM data. ## Features -- Customisable. Many of `opticam_new`'s reduction methods are fully customisable, allowing for full control over the reduction process. -- Informative. `opticam_new` includes informative logging, allowing for reproducable reduction and information about any errors or warnings. -- Robust. `opticam_new` is designed to catch many common errors and inform the user how they can be resolved. -- Scalable. `opticam_new` can leverage modern multi-core CPUs to drastically speed up reduction. -- Simple. When using `opticam_new`'s reduction methods, the default values should "just work" most of the time. Faint sources and/or crowded fields may require some tailoring, however. +- Customisable. Many of `opticam`'s reduction methods are fully customisable, allowing for full control over the reduction process. +- Informative. `opticam` includes informative logging, allowing for reproducable reduction and information about any errors or warnings. +- Robust. `opticam` is designed to catch many common errors and inform the user how they can be resolved. +- Scalable. `opticam` can leverage modern multi-core CPUs to drastically speed up reduction. +- Simple. When using `opticam`'s reduction methods, the default values should "just work" most of the time. Faint sources and/or crowded fields may require some tailoring, however. ## Installation ### From GitHub (recommended) -You can install the latest stable release of `opticam_new` directly from GitHub using: +You can install the latest stable release of `opticam` directly from GitHub using: ``` -pip install git+https://github.com/zairving/opticam_new.git +pip install git+https://github.com/zairving/opticam.git ``` ### Locally -If you have a local copy of `opticam_new`, it can be `pip` installed by navigating to the directory and running: +If you have a local copy of `opticam`, it can be `pip` installed by navigating to the directory and running: ``` pip install . @@ -28,8 +28,8 @@ pip install . ### Requirements -All of `opticam_new`'s dependencies are available as Python packages via your preferred package manager, and should be handled automatically via `pip`. If you would prefer to install the dependencies via `conda`, use provided [YAML file](environment.yml) to set up your environment, and then install `opticam_new` via `pip` as described above. +All of `opticam`'s dependencies are available as Python packages via your preferred package manager, and should be handled automatically via `pip`. If you would prefer to install the dependencies via `conda`, use provided [YAML file](environment.yml) to set up your environment, and then install `opticam` via `pip` as described above. ## Getting Started -Documentation for `opticam_new` is available on [Read the Docs](https://opticam-new.readthedocs.io/en/latest/index.html). To get started, I recommend checking out the [reduction tutorial](https://opticam-new.readthedocs.io/en/latest/tutorials/reduction.html). \ No newline at end of file +Documentation for `opticam` is available on [Read the Docs](https://opticam-new.readthedocs.io/en/latest/index.html). To get started, I recommend checking out the [reduction tutorial](https://opticam-new.readthedocs.io/en/latest/tutorials/reduction.html). \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 9f14ce1..34bc557 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,9 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'opticam_new' -copyright = '2025, Zackery Irving' -author = 'Zackery Irving' +project = 'opticam' +copyright = '2025, Zackery A. Irving' +author = 'Zackery A. Irving' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -22,7 +22,7 @@ 'nbsphinx', ] autoapi_dirs = [ - "../opticam_new" + "../opticam" ] autodoc_typehints = 'description' diff --git a/docs/index.rst b/docs/index.rst index 49a2ecf..d91f181 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,4 @@ -opticam_new +opticam ===== A Python package for reducing OPTICAM data.