Metadata-Version: 2.1
Name: ANU-inversion-course
Version: 0.1.0.dev5
Summary: ANU Inversion Course Package
Author: InLab
License: UNKNOWN
Keywords: inversion,inference,geoscience,geophysics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.22.2)
Requires-Dist: matplotlib (>=3.5.0)
Requires-Dist: scipy (>=1.7.0)
Requires-Dist: tqdm (>=4.62.0)
Requires-Dist: seaborn (>=0.11.0)

# ANU Inversion Course Package

[![Build](https://github.com/anu-ilab/ANUInversionCourse/actions/workflows/build_wheels.yml/badge.svg?branch=main)](https://github.com/anu-ilab/ANUInversionCourse/actions/workflows/build_wheels.yml)
[![PyPI version](https://badge.fury.io/py/ANU-inversion-course.svg)](https://badge.fury.io/py/ANU-inversion-course)

This package contains resources to be used in the [inversion course practicals](https://github.com/anu-ilab/JupyterPracticals).

## Getting started

### 1. Set up virtual environment
(optional) It's recommended to use a virtual environment (using `conda` or `venv`, etc.) so that it doesn't conflict with your other Python projects. Create a new environment with 
```console
conda create -n inversion_course python=3.10 jupyterlab
``` 
and enter that environment with 
```console
conda activate inversion_course
```

### 2. Dependency
A *Fortran compiler* is needed for Apple Silicon M1, and Fortran libraries (`libgfortran11`) is also needed for other operating systems. So remember to have `gfortran` installed before installing this package. Check [this page](https://fortran-lang.org/learn/os_setup/install_gfortran) for instructions on how to download it.

<details>
  <summary>Notes for MacOS</summary>

  Make sure you have `xcode` installed (from App Store), and then the command line tools installed by opening terminal and typing in:
  ```console
  xcode-select --install
  ```

  For M1 chip: if you've set up a conda environment, then another option is to install `gfortran` using `conda`:
  ```console
  conda install -c conda-forge gfortran
  ```
  The `gfortran` version is updated (`gfortran-11`) for M1 chip but not for the Intel one (as per [this](https://anaconda.org/conda-forge/gfortran))

</details>


### 3. Installation
Type the following in your terminal:

```bash
pip install anu-inversion-course
```
### 4. Check
And when you run `jupyter-lab` to do the practicals, make sure you are in the same environment as where your `anu-inversion-course` was installed. You can try to test this by checking if the following commands give you similar result:

```console
$ which pip
<some-path>/bin/pip
$ which jupyter-lab
<same-path>/bin/jupyter-lab
$ pip list | grep ANU-inversion-course
ANU-inversion-course               0.1.0
```





