Skip to content

Commit

Permalink
fix small typos in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Swanson-Hysell authored Sep 11, 2023
1 parent 4fc6099 commit 2beb799
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can open a cloud JupyterHub version of all the code in this repository and e

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
The notebooks in this repository can be directly been access though the following JupyterBook. This link opens a website
where all the notebooks can be visualized.

[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/)
Expand All @@ -33,16 +33,16 @@ This repository includes a series of tools and code organized in different folde
- `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.
We also provide 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
All the notebooks inside this notebook can be executed after properly setting the environment. The `environment.yml` file can be used to
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.

In order to install the environment, you can use conda or mamba (see [Managing Environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) for more information) with `conda env create -f environment.yml`. Alternativelly, we included a `Makefile` that allow to create the conda environment and install the associated iPython kernel so this environment can be accessible though Jupyter notebooks all at once. In order to do this, you just need to open a terminal where the repository is located and enter
In order to install the environment, you can use conda or mamba (see [Managing Environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) for more information) with `conda env create -f environment.yml`. Alternatively, we included a `Makefile` that creates the conda environment and installs the associated iPython kernel so this environment can be accessible though Jupyter notebooks all at once. In order to use the Makefile, you need to open a terminal where the repository is located and enter
```
make env
```
Expand Down

0 comments on commit 2beb799

Please sign in to comment.