Skip to content

Commit

Permalink
trigger new README in Main
Browse files Browse the repository at this point in the history
  • Loading branch information
@facusapienza21
facusapienza21 committed Sep 9, 2023
1 parent 4e325bf commit ab8ede9
Showing 1 changed file with 22 additions and 26 deletions.
48 changes: 22 additions & 26 deletions book/Main.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 2,
"id": "f70fb492-b3f7-409c-8e95-5273dbe281ff",
"metadata": {},
"outputs": [
Expand All @@ -23,15 +23,19 @@
"text/markdown": [
"### ⚠️ New preprint available! ⚠️\n",
"\n",
"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). \n",
"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).\n",
"\n",
"[![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)\n",
"[![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) \n",
"\n",
"[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/) [![Build Status](https://github.com/PolarWandering/PaleoSampling/actions/workflows/book.yml/badge.svg?branch=main)](https://github.com/PolarWandering/PaleoSampling/actions/workflows/book.yml?query=branch%3Amain)\n",
"\n",
"[![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)](./.github/workflows/book.yml) [![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)\n",
"\n",
"## Quantitative Analysis of Paleomagnetic Sampling Strategies\n",
"\n",
"This repository contains all the notebooks and code to reproduce the analysis for the different sampling procedures in order\n",
"to estimate the precision of different strategies for estimating paleomagnetic poles and paleosecular variation of the magnetic field \n",
"based on site magnetizations. \n",
"to estimate the precision of different strategies for estimating paleomagnetic poles and paleosecular variation of the magnetic field\n",
"based on site magnetizations.\n",
"\n",
"You can open a cloud JupyterHub version of all the code in this repository and execute it using the following Binder link:\n",
"\n",
Expand All @@ -40,46 +44,46 @@
"Learn more about the Binder project in this [link](https://mybinder.readthedocs.io/en/latest/).\n",
"\n",
"The notebooks in this repository can be directly been access thought the following JupyterBook. This link opens a website\n",
"where all the notebooks can be visualized. \n",
"where all the notebooks can be visualized.\n",
"\n",
"[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/)\n",
"\n",
"### Organization\n",
"\n",
"This repository includes a series of tools and code organized in different folders: \n",
"This repository includes a series of tools and code organized in different folders:\n",
"- `notebooks`: It includes Jupyter Notebooks with examples of different sampling procedures and the code to parallelize the simulations using Dask (`Parallel.ipynb`).\n",
"- `figures`: It includes all the Jupyter Notebooks to generate the figures in the paper. \n",
"- `figures`: It includes all the Jupyter Notebooks to generate the figures in the paper.\n",
"- `outputs`: It includes the simulated data from all the simulations used in the figures in `csv` format.\n",
"- `smpsite`: Python package to run simulations and estimate poles and dispersion (see Installation for more information). \n",
"- `smpsite`: Python package to run simulations and estimate poles and dispersion (see Installation for more information).\n",
"\n",
"We also provide with an `environment.yml` and `Makefile` for setup of the computational environment used for this project. \n",
"We also provide with an `environment.yml` and `Makefile` for setup of the computational environment used for this project.\n",
"\n",
"### Installation\n",
"\n",
"All the notebooks inside this notebook can be executed after properly setting the environmnet. The `environment.yml` file can be used to \n",
"install all the required dependencies. Beside some standard Python dependencies, the `environment.yml` file include the installation of \n",
"`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 \n",
"estimated poles. \n",
"All the notebooks inside this notebook can be executed after properly setting the environmnet. The `environment.yml` file can be used to\n",
"install all the required dependencies. Beside some standard Python dependencies, the `environment.yml` file include the installation of\n",
"`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\n",
"estimated poles.\n",
"\n",
"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\n",
"```\n",
"make env\n",
"```\n",
"\n",
"Alternatively, if you just want to install the `smpsite` module, you can clone this repository and do \n",
"Alternatively, if you just want to install the `smpsite` module, you can clone this repository and do\n",
"```\n",
"pip install smpsite\n",
"```\n",
"or \n",
"or\n",
"```\n",
"pip install -e smpsite\n",
"```\n",
"if you are working in developer mode. \n",
"if you are working in developer mode.\n",
"\n",
"\n",
"### Makefile\n",
"\n",
"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 \n",
"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\n",
"path to this repository and use the following commands to trigger their respective actions. \n",
"- `make env`: Creates the conda environment associated with the `environment.yml` file and then creates the respective iPython kernel such that the \n",
"environment can be accessed via Jupyter notebooks. \n",
Expand Down Expand Up @@ -114,14 +118,6 @@
"\n",
"display(Markdown(\"../README.md\"))"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "dbdf4ec6-d5c3-4654-933f-366910e03ca4",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit ab8ede9

Please sign in to comment.