Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
7eb4f40
feat: added aperture diameter and airmass keyword attributes to instr…
zairving Apr 23, 2026
f697abb
misc: renamed propagate_errors() to combine_variances(), which now re…
zairving Apr 23, 2026
e3adf6e
feat: get_data() now returns the relative scintillation noise
zairving Apr 23, 2026
180fd97
feat: added percentile parameter to plot_catalogs() allowing for bett…
zairving Apr 23, 2026
190c972
feat: added pick_sources() method to Reducer, allowing users to manua…
zairving Apr 23, 2026
057bcbb
feat: photometers now account for scintillation noise
zairving Apr 23, 2026
3100ef0
feat: added scintillation noise to noise.py
zairving Apr 23, 2026
d58af92
feat: time-varying systematics (FWHM, airmass, scintillation noise) a…
zairving Apr 24, 2026
18da964
feat: implemented median filtering option as recommended in Paez+2026…
zairving Apr 28, 2026
395aa8c
feat: added diameter and airmass attributes/methods to Instrument bas…
zairving Apr 28, 2026
0b1b8b0
misc: airmass helper functions
zairving Apr 28, 2026
e83d97a
misc: added median filtering to correctors
zairving Apr 28, 2026
c147d24
misc: updated systematics plot for clarity
zairving Apr 28, 2026
fcb3532
feat: added median filter to Reducer
zairving Apr 28, 2026
5627774
feat: previous implementation of median filtering was a misinterpreta…
zairving Apr 28, 2026
06ab871
misc: added AIRMASS keyword to generated image headers
zairving May 11, 2026
bc6ddc3
misc: refactored SNR plotting code
zairving May 11, 2026
8f97eb7
misc: relaxed dependency version requirements
zairving Jun 15, 2026
6c2fd19
misc: removed .gz extension from generated FITS images
zairving Jun 15, 2026
73630db
misc: clarified axis titles in alignment GIF files
zairving Jun 15, 2026
bbf747e
feat: added region_size parameter to pick_sources() method of Reducer…
zairving Jun 15, 2026
b24c882
docs: updated tutorials
zairving Jun 15, 2026
38cbe43
misc: bumped version number to 0.7.0
zairving Jun 16, 2026
6e1c2d8
bug: changed a number of attribute names and dictionary keys for comp…
zairving Jun 16, 2026
b0f4434
docs: updated tutorials
zairving Jun 16, 2026
fba6dfc
misc: renamed package from opticam to phoptic
zairving Jun 16, 2026
b0fcd80
misc: removed unfinished code from analyzer.py
zairving Jun 16, 2026
fe4e16e
misc: moved models.py
zairving Jun 16, 2026
9e04804
misc: moved timeseries.py
zairving Jun 16, 2026
c4190ac
docs: updated README
zairving Jun 16, 2026
777be25
docs: updated documentation
zairving Jun 16, 2026
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 @@ -9,8 +9,8 @@ authors:
orcid: http://orcid.org/0000-0002-5870-0443

title: "opticam"
version: 0.6.0
version: 0.7.0
identifiers:
# - type: doi
# value: 10.5281/zenodo.1234
date-released: 2025-03-13
date-released: 2025-06-16
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# opticam
A Python package for reducing OPTICAM data.
# phoptic
A Python package for reducing astronomical images.

## Features
- 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.
- Customisable. Many of `phoptic`'s reduction methods are fully customisable, allowing for full control over the reduction process.
- Informative. `phoptic` includes informative logging, allowing for reproducable reduction and information about any errors or warnings.
- Robust. `phoptic` is designed to catch many common errors and inform the user how they can be resolved.
- Scalable. `phoptic` can leverage modern multi-core CPUs to drastically speed up reduction.
- Simple. When using `phoptic`'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

### Option 1: Docker (Recommended for Avoiding Compatibility Issues)

The safest way to get started with `opticam` is using Docker, which provides a complete environment with Jupyter Lab. This has the benefit of "containerizing" the installation, avoiding any conflicts or compatibility issues:
The safest way to get started with `phoptic` is using Docker, which provides a complete environment with Jupyter Lab. This has the benefit of "containerizing" the installation, avoiding any conflicts or compatibility issues:

```bash
# Copy the environment configuration
Expand All @@ -29,24 +29,24 @@ For a more complete Docker setup guide, see [DOCKER.md](DOCKER.md).

### Option 2: From GitHub

You can install the latest stable release of `opticam` directly from GitHub using:
You can install the latest stable release of `phoptic` directly from GitHub using:

```
pip install git+https://github.com/OPTICAM-instrument/opticam.git
```

### Option 3: Locally

If you have a local copy of `opticam`, it can be `pip` installed by navigating to the directory and running:
If you have a local copy of `phoptic`, it can be `pip` installed by navigating to the directory and running:

```
pip install .
```

### Requirements

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.
All of `phoptic`'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` is available on [Read the Docs](https://opticam.readthedocs.io/en/latest/index.html). To get started, I recommend checking out the [reduction tutorial](https://opticam.readthedocs.io/en/latest/tutorials/reduction.html).
Documentation for `phoptic` is available on [Read the Docs](https://phoptic.readthedocs.io/en/latest/index.html). To get started, I recommend checking out the [reduction tutorial](https://phoptic.readthedocs.io/en/latest/tutorials/reduction.html).
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation

To generate the Sphinx documentation for `opticam`, install the package with its documentation requirements:
To generate the Sphinx documentation for `phoptic`, install the package with its documentation requirements:

```
pip install -e .[docs]
Expand Down
Loading
Loading