Skip to content

Added a simple example to the README #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roytsmart merged 1 commit into from
Dec 13, 2025
Merged

Added a simple example to the README #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,37 @@

A Python library for characterizing and using the CCD cameras developed by Marshall Space Flight Center.

More information is available in the [documentation](https://msfc-ccd.readthedocs.io/).

## Installation

`msfc-ccd` is available on PyPI and can be installed using pip:

```shell
pip install msfc-ccd
```

## Examples

Load and display a single FITS file.

```python3
import matplotlib.pyplot as plt
import named_arrays as na
import msfc_ccd

# Load the sample image
image = msfc_ccd.fits.open(msfc_ccd.samples.path_fe55_esis1)

# Display the sample image
fig, ax = plt.subplots(
constrained_layout=True,
)
im = na.plt.imshow(
image.outputs.value,
axis_x=image.axis_x,
axis_y=image.axis_y,
ax=ax,
);
```
![A sample FITS image](https://msfc-ccd.readthedocs.io/en/latest/_images/index_0_0.png)