Astronomical Data Science and Machine Learning Toolkit
Project description
spacekit
Astronomical Data Science and Machine Learning Toolkit
Setup
Install with pip
# install extra deps for all non-pipeline tools (analysis, training, data viz)
$ pip install spacekit[x]
# for bare-minimum dependencies (STScI/SDP pipeline operations):
$ pip install spacekit
Install from source
$ git clone https://github.com/spacetelescope/spacekit
$ cd spacekit
$ pip install -e .[x]
Testing
See tox.ini for a list of test suite markers.
# run all tests
$ pytest
# specify the `env` option to limit tests to a specific 'skope'
# env options: "svm", "hstcal", "jwstcal"
$ pytest --env svm -m svm
$ pytest --env hstcal -m cal
$ pytest --env jwstcal -m jwst
Pre-Trained Neural Nets
JWST Calibration Pipeline Resource Prediction (JWST)
- Inference
spacekit.skopes.jwst.cal.predict
From the command line:
$ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs
# optionally specify a Program ID
$ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
From python:
> from spacekit.skopes.jwst.cal.predict import JwstCalPredict
> input_path = "/path/to/level1/exposures"
# optionally specify a Program ID `pid` (default is None)
> jcal = JwstCalPredict(input_path, pid=1076)
> jcal.run_inference()
# estimations for L3 product memory footprints (GB) are stored in a dict under the `predictions` attribute. Ground truth values (latest actual footprints recorded) are shown as inline comments.
> jcal.predictions
{
'jw01076-o101-t1_nircam_clear-f212n': {'gbSize': 10.02}, # actual: 10.553384
'jw01076-o101-t1_nircam_clear-f210m': {'gbSize': 8.72}, # actual: 11.196752
'jw01076-o101-t1_nircam_clear-f356w': {'gbSize': 7.38}, # actual: 6.905737
}
# NOTE: the target number "t1" is not intended to match actual target IDs used by the pipeline.
Single Visit Mosaic Alignment (HST)
- Preprocessing:
spacekit.skopes.hst.svm.prep - Predict Image Alignments:
spacekit.skopes.hst.svm.predict - Train Ensemble Classifier:
spacekit.skopes.hst.svm.train - Generate synthetic misalignments†:
spacekit.skopes.hst.svm.corrupt
† requires Drizzlepac
HST Calibration Pipeline Resource Prediction (HST)
- Training
spacekit.skopes.hst.cal.train - Inference
spacekit.skopes.hst.cal.predict
Exoplanet Detection with time-series photometry (K2, TESS)
spacekit.skopes.kepler.light_curves
Customizable Model Building Classes
Build, train and experiment with multiple model iterations using the builder.architect.Builder classes
Example: Build and train an MLP and 3D CNN ensemble network
- continuous/encoded data for the multi-layer perceptron
- 3 RGB image "frames" per image input for the CNN
- Stack mixed inputs and use the outputs of MLP and CNN as inputs for the final ensemble model
ens = BuilderEnsemble(XTR, YTR, XTS, YTS, name="svm_ensemble")
ens.build()
ens.batch_fit()
# Save Training Metrics
outputs = f"data/{date_timestamp}"
com = ComputeBinary(builder=ens, res_path=f"{outputs}/results/test")
com.calculate_results()
Load and plot metrics to evaluate and compare model performance
Analyze and compare results across iterations from metrics saved using analyze.compute.Computer class objects. Almost all plots are made using plotly and are dynamic/interactive.
# Load data and metrics
from spacekit.analyzer.scan import MegaScanner
res = MegaScanner(perimeter="data/2022-*-*-*")
res._scan_results()
Preprocessing and Analysis Tools for Space Telescope Instrument Data
from spacekit.analyzer.explore import HstCalPlots
res.load_dataframe()
hst = HstCalPlots(res.df, group="instr")
hst.scatter
spacekit
└── spacekit
└── analyzer
└── compute.py
└── explore.py
└── scan.py
└── track.py
└── builder
└── architect.py
└── blueprints.py
└── trained_networks
└── dashboard
└── cal
└── svm
└── datasets
└── _base.py
└── beam.py
└── meta.py
└── extractor
└── load.py
└── radio.py
└── scrape.py
└── generator
└── augment.py
└── draw.py
└── logger
└── log.py
└── preprocessor
└── encode.py
└── ingest.py
└── prep.py
└── scrub.py
└── transform.py
└── skopes
└── hst
└── cal
└── config.py
└── predict.py
└── train.py
└── validate.py
└── svm
└── corrupt.py
└── predict.py
└── prep.py
└── train.py
└── jwst
└── cal
└── config.py
└── predict.py
└── train.py
└── kepler
└── light_curves.py
└── pyproject.toml
└── setup.cfg
└── tox.ini
└── tests
└── docker
└── docs
└── scripts
└── LICENSE
└── README.md
└── CONTRIBUTING.md
└── CODE_OF_CONDUCT.md
└── MANIFEST.in
└── bandit.yml
└── readthedocs.yaml
└── conftest.py
└── CHANGES.rst
/\ _ _ _ *
/\_/\_____/ \__| |_____| |_________________________| |___________________*___
[===] / /\ \ | | _ | _ | _ \/ __/ -__| \| \_ _/ _ \ \_/ | * _/| | |
\./ /_/ \_\|_| ___|_| |_|__/\_\ \ \____|_|\__| \__/__/\_\___/|_|\_\|_|_|
| / |___/
|/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file spacekit-1.1.3.tar.gz.
File metadata
- Download URL: spacekit-1.1.3.tar.gz
- Upload date:
- Size: 7.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ac99b554061c8c0fa04b479041d412862c50a019624fe0f4151ad9197cb2c28b
|
|
| MD5 |
75225e4b8bb98fa41b1c4520ed2de324
|
|
| BLAKE2b-256 |
ec9cd9a0ab054ad9c17ad7d1a5f16c5a4e09b924f0a5105aba48d7549148d9c7
|
Provenance
The following attestation bundles were made for spacekit-1.1.3.tar.gz:
Publisher:
publish_to_pypi.yml on spacetelescope/spacekit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
spacekit-1.1.3.tar.gz -
Subject digest:
ac99b554061c8c0fa04b479041d412862c50a019624fe0f4151ad9197cb2c28b - Sigstore transparency entry: 268059102
- Sigstore integration time:
-
Permalink:
spacetelescope/spacekit@243cc691cd2468db59b661f97c16b0dc6f61f673 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/spacetelescope
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@243cc691cd2468db59b661f97c16b0dc6f61f673 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file spacekit-1.1.3-py3-none-any.whl.
File metadata
- Download URL: spacekit-1.1.3-py3-none-any.whl
- Upload date:
- Size: 7.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bebd540f4392a2df3f385551bd1110e557641ee1f76ef7dd7777e98fe5142cde
|
|
| MD5 |
9967d78090e835f6128cab4183be0a29
|
|
| BLAKE2b-256 |
b1f371872c49812fc2658c7fb75bf8dc8a849cff5712500105e427f88d379f36
|
Provenance
The following attestation bundles were made for spacekit-1.1.3-py3-none-any.whl:
Publisher:
publish_to_pypi.yml on spacetelescope/spacekit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
spacekit-1.1.3-py3-none-any.whl -
Subject digest:
bebd540f4392a2df3f385551bd1110e557641ee1f76ef7dd7777e98fe5142cde - Sigstore transparency entry: 268059114
- Sigstore integration time:
-
Permalink:
spacetelescope/spacekit@243cc691cd2468db59b661f97c16b0dc6f61f673 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/spacetelescope
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish_to_pypi.yml@243cc691cd2468db59b661f97c16b0dc6f61f673 -
Trigger Event:
workflow_dispatch
-
Statement type: