Metadata-Version: 2.1
Name: pgdtools
Version: 0.0.1
Summary: Package to interact with the presolar grain database.
Home-page: https://github.com/galactic-forensics/pgdtools
Author: Reto Trappitsch
Author-email: reto@galactic-forensics.space
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: iniabu>=1.0.1
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: darglint>=1.5.1 ; extra == "dev"
Requires-Dist: flake8>=4,<5 ; extra == "dev"
Requires-Dist: flake8-bandit ; extra == "dev"
Requires-Dist: flake8-black ; extra == "dev"
Requires-Dist: flake8-bugbear ; extra == "dev"
Requires-Dist: flake8-docstrings ; extra == "dev"
Requires-Dist: flake8-import-order ; extra == "dev"
Requires-Dist: bandit==1.7.2 ; extra == "dev"
Requires-Dist: hypothesis ; extra == "dev"
Requires-Dist: pytest>=6.0.0 ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-mock ; extra == "dev"
Requires-Dist: pytest-sugar ; extra == "dev"
Requires-Dist: requests ; extra == "dev"
Provides-Extra: dev

# Presolar grain database tools (pgdTools)

Currently under development.

This folder contains a very rough draft /
development version /
idea gathering file(s)
for `pgdtools`.
Use at your own risk!

The idea behind this folder is to have a place
to share (really) early versions of `pgdtools`
with colleagues for testing
and feedback.
Thinks might change at any time!
There's no guarantee for consistency,
or anything, you've been warned.
That being said,
there should also be example files.
Have a look at the latest dates, etc.,
in order to find one that might work.

Feedback extremely welcome!

## Installation

### Jupyterlab server (e.g., WENDI, ...)

In the first cell of your jupyter notebook,
run the following code:

```
%pip install git+https://github.com/galactic-forensics/pgdtools.git
```

This should pull the latest version
of `pgdtools` from GitHub and install it.
To test, follow steps below.

### Local

To use this module,
clone this repository
and enter it:
```bash
git clone https://github.com/galactic-forensics/pgdtools.git
cd pgdtools
```

It is recommended that you use
a virtual python environment for the following steps.
Also: these steps have been tested with python 3.9.

First, install the python requirements,
then the package itself.
You can skip the jupyter and ipython line if you
do not want to use these tools.

```
pip install .
```

### Give it a spin

Now you should be ready to use `pgdtools`
from your session. Try the following:

```python
import pgdtools

pg = pgdtools.PresolarGrains()
```

If this does not throw an error,
you should be fine and the
presolar grain database was found.

## Examples

The `examples` folder contains some examples for you to read through.
There are some pure python exampmles,
as well as an ipython notebook for your consideration.
Please let me know if things are unclear, etc.

## Presolar grain database

The presolar grain database
can be found at
https://presolar.physics.wustl.edu/presolar-grain-database/.
Note that only the SiC database
is currently thought of being error free.
The current version of `pgdtools`
includes the 2021-01-10 version
of the presolar SiC grain database,
which is the current version as of this writing (Nov 2021).

## Development

To make a development installation,
type:

```python
pip install -e .[dev]
```

This will install all required packages.

More to come on this...

