Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hombit authored Oct 15, 2021
1 parent ce412df commit c2bbebd
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,17 @@ The most of the code base is written on Rust and split into several crates.

### Structure

- `light-curve`**WIP** A crate which will be an umbrella for other Rust crates

- `light-curve-common` [![docs.rs badge](https://docs.rs/light-curve-common/badge.svg)](https://docs.rs/light-curve-common) Common tools for other crates

- `light-curve-dmdt` [![docs.rs badge](https://docs.rs/light-curve-dmdt/badge.svg)](https://docs.rs/light-curve-dmdt) [dm-dt](https://arxiv.org/abs/1709.06257) mapper crate and executable

- `light-curve-feature` [![docs.rs badge](https://docs.rs/light-curve-feature/badge.svg)](https://docs.rs/light-curve-feature) A collection of features to be extracted from light curves
- [`light-curve`](./light-curve)**WIP** A crate which will be an umbrella for other Rust crates
- [`light-curve-common`](./light-curve-common) ![Crates.io](https://img.shields.io/crates/v/light-curve-common) [![docs.rs badge](https://docs.rs/light-curve-common/badge.svg)](https://docs.rs/light-curve-common) Common tools for other crates
- [`light-curve-dmdt`](./light-curve-dmdt) ![Crates.io](https://img.shields.io/crates/v/light-curve-dmdt) [![docs.rs badge](https://docs.rs/light-curve-dmdt/badge.svg)](https://docs.rs/light-curve-dmdt) [dm-dt](https://arxiv.org/abs/1709.06257) mapper crate and executable
- [`light-curve-feature`](./light-curve-feature) ![Crates.io](https://img.shields.io/crates/v/light-curve-feature) [![docs.rs badge](https://docs.rs/light-curve-feature/badge.svg)](https://docs.rs/light-curve-feature) A collection of features to be extracted from light curves
- `light-curve-interpol`**WIP** Light curve interpolation tools. Currently it includes linear interpolation only
- `light-curve-python` [![PyPI version](https://badge.fury.io/py/light-curve-python.svg)](https://pypi.org/project/light-curve-python/) Python bindings to `light-curve-dmdt` and `light-curve-feature`. Note that in the future releases `light-curve-python`Python package will be renamed to `light-curve`.
- `test-data` is [a Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) linking to [the `test-data` repository](https://github.com/light-curve/test-data) containing light curves required for testing, benchmarking and development of the new features. Use `git clone --recurse-submodules` to download this repo with all submodules
- `test-data` is [a Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) linking to [the `test-data` repository](https://github.com/light-curve/test-data) containing light curves required for testing, benchmarking and development of the new features. Use `git clone --recurse-submodules` to download the repo with this submodule
- `.ci` Continuous integration related stuff, currently it is just a custom Docker [maturin](https://github.com/pyo3/maturin) image used to publish x86-64 Linux Python packages via Github Actions
- `.github` GitHub related utils, such as dependabot configuration and Actions workflows

### Visioning
### Versioning

All package versions are unrelated, which means that `light-curve-python v0.a.b` can depend on `light-curve-dmdt v0.d.e` and `light-curve-feature v0.f.g`. We use [semver](https://semver.org), so a release `0.3.0` can be backward incompatible with `0.2.5` version of the same crate. Please refer to `CHAMGELOG.md` in sub-directories for the changes between versions.

Expand All @@ -47,4 +44,3 @@ archivePrefix = {arXiv},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

0 comments on commit c2bbebd

Please sign in to comment.