ANU-inversion-course 0.1.0.dev7

ANU Inversion Course Package

ANU Inversion Course Package

This package contains resources to be used in the inversion course practicals.

Table of contents

• Getting started
  • Set up virtual environment
  • Dependency
  • Installation
  • Check
• Troubleshooting
• Developer notes

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

conda create -n inversion_course python=3.10

and enter that environment with

conda activate inversion_course

2. Dependency

This package requires you to have gfortran installed. Check this page (and notes below for MacOS) for instructions on how to install gfortran.

Notes for installing `gfortran` on MacOS

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

xcode-select --install

For M1 chip: if you've set up a conda environment, then another option is to install gfortran using conda:

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)

Reasons for why we need `gfortran`

• A Fortran compiler is needed for MacOS to build C/Fortran libraries from source, as wheels are not provided for MacOS due to a problem described here.
• Fortran libraries (libgfortran.5.dylib) is also needed for other operating systems. Otherwise anu_inversion_course.rf will fail to import.

3. Installation

Type the following in your terminal:

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:

$ 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

Troubleshooting

If you find problems importing anu_inversion_course.rf, try to search the error message you get. Here contains a nice explanation for the possible cause. And here is how to locate libgfortran:

gfortran --print-file-name libgfortran.5.dylib

Developer Notes

Check out NOTES.md if you'd like to contribute to this package.

1. Getting started
2. Cheatsheet
   1. conda environment
   2. git operations
   3. package development
   4. package metadata
   5. package building test & release
3. Adding C/C++ extensions
4. Adding Fortran extensions
5. More references
6. Appendix - semantic versioning