Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.
Merged

Dev #56

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# 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 .
```

### 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).
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).
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -22,7 +22,7 @@
'nbsphinx',
]
autoapi_dirs = [
"../opticam_new"
"../opticam"
]
autodoc_typehints = 'description'

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
opticam_new
opticam
=====

A Python package for reducing OPTICAM data.
Expand Down