Skip to content

Commit

Permalink
fix typos and make some word choice changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Swanson-Hysell committed Sep 6, 2023
1 parent ac0f088 commit 1f69a4a
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
### ⚠️ New preprint available! ⚠️

For a detailed description of the project, take a look at [our preprint at JGR](https://www.authorea.com/doi/full/10.22541/essoar.168881772.25833701).
For a detailed description of the project, take a look at [our preprint of a manuscript that is in revision at JGR](https://www.authorea.com/doi/full/10.22541/essoar.168881772.25833701).

[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PolarWandering/PaleoSampling/HEAD) [![DOI](https://zenodo.org/badge/595793364.svg)](https://zenodo.org/badge/latestdoi/595793364)

## Quantitative Analysis of Paleomagnetic Sampling Strategies

This repository contains all the requirement notebooks and code to reproduce the analysis for the different sampling procedures in order
to estimate the precision of different strategies at the moment of estimating paleomagnetic poles and secular variation of the magnetic field
based on site observations.
This repository contains all the notebooks and code to reproduce the analysis for the different sampling procedures in order
to estimate the precision of different strategies for estimating paleomagnetic poles and paleosecular variation of the magnetic field
based on site magnetizations.

You can open a cloud JupyterHub version of all the code in this repository and execute it using the following Binder link:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PolarWandering/PaleoSampling/HEAD)

Lear more about the Binder project in this [link](https://mybinder.readthedocs.io/en/latest/).
Learn more about the Binder project in this [link](https://mybinder.readthedocs.io/en/latest/).

The notebooks in this repository can be directly been access thought the following JupyterBook. This link opens a website
where all the notebooks can been visualized.
where all the notebooks can be visualized.

[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/)

### Organization

This repository includes a series of tools and code organized in different folders.
This repository includes a series of tools and code organized in different folders:
- `notebooks`: It includes Jupyter Notebooks with examples of different sampling procedures and the code to parallelize the simulations using Dask (`Parallel.ipynb`).
- `figures`: It includes all the Jupyter Notebooks to generate the figures in the paper.
- `outputs`: It inclides the simulated data from all the simulations used in the figures in `csv` format.
- `outputs`: It includes the simulated data from all the simulations used in the figures in `csv` format.
- `smpsite`: Python package to run simulations and estimate poles and dispersion (see Installation for more information).

We also provide with an `environment.yml` and `Makefile` for setup of the computational environment used for this project.

### Installation

All the notebooks inside this notebook can be executed after properly setting the environmnet. The `environment.yml` file can be used to
install all the requiered dependencies. Beside some standard Python dependencies, the `environment.yml` file include the installation of
install all the required dependencies. Beside some standard Python dependencies, the `environment.yml` file include the installation of
`Pmagpy` using pip and the extra installation of the module `smpsite` (included in this repository). The package `smpsite` includes all the code used to make the simulations and compute the
estimated poles.

Expand All @@ -43,7 +43,7 @@ In order to install the environment, you can use conda or mamba (see [Managing E
make env
```

Alternativelly, if you just want to install the `smpsite` modeule, you can simply clone this repository and do
Alternatively, if you just want to install the `smpsite` module, you can clone this repository and do
```
pip install smpsite
```
Expand All @@ -56,9 +56,9 @@ if you are working in developer mode.

### Makefile

The current repository counts with a `Makefile` that allows the user to run different routines on the code. You can move in a terminal to the
path to this repository and use the following commnands to trigger their respective actions.
- `make env`: Creates the conda environment associated to the `environment.yml` file and then creates the respective iPython kernel such that the
The current repository contains a `Makefile` that allows the user to run different routines on the code. You can move in a terminal to the
path to this repository and use the following commands to trigger their respective actions.
- `make env`: Creates the conda environment associated with the `environment.yml` file and then creates the respective iPython kernel such that the
environment can be accessed via Jupyter notebooks.
- `make help`: Prints a short description of all available commands and their explanation.

Expand All @@ -74,6 +74,6 @@ If you want to cite this work, please use this BibTex citation from [our latest
publisher={Authorea}
}
```
If you want to cite the software in this repository, you can instead used the following DOI in Zenodo:
If you want to cite the software in this repository, you can instead use the following DOI in Zenodo:

[![DOI](https://zenodo.org/badge/595793364.svg)](https://zenodo.org/badge/latestdoi/595793364)

0 comments on commit 1f69a4a

Please sign in to comment.