Skip to content

Commit

Permalink
refreash README in Main.pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
@facusapienza21
facusapienza21 committed Sep 14, 2023
1 parent 70c7986 commit 904bb3b
Showing 1 changed file with 45 additions and 12 deletions.
57 changes: 45 additions & 12 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": 2,
"execution_count": 1,
"id": "f70fb492-b3f7-409c-8e95-5273dbe281ff",
"metadata": {},
"outputs": [
Expand All @@ -25,11 +25,12 @@
"\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",
"[![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) \n",
"[![DOI](https://zenodo.org/badge/595793364.svg)](https://zenodo.org/badge/latestdoi/595793364) \n",
"[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/) \n",
"[![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",
"[![All Contributors](https://img.shields.io/github/all-contributors/PolarWandering/PaleoSampling?color=ee8449&style=flat-square)](#contributors)\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",
Expand All @@ -41,9 +42,9 @@
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PolarWandering/PaleoSampling/HEAD)\n",
"\n",
"Learn more about the Binder project in this [link](https://mybinder.readthedocs.io/en/latest/).\n",
"Learn more about the Binder project in this [link](https://mybinder.readthedocs.io/en/latest/). Note that it will take a very long time to load.\n",
"\n",
"The notebooks in this repository can be directly been access thought the following JupyterBook. This link opens a website\n",
"The notebooks in this repository can be directly been access though the following JupyterBook. This link opens a website\n",
"where all the notebooks can be visualized.\n",
"\n",
"[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://polarwandering.github.io/PaleoSampling/)\n",
Expand All @@ -56,16 +57,16 @@
"- `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",
"\n",
"We also provide with an `environment.yml` and `Makefile` for setup of the computational environment used for this project.\n",
"We also provide 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",
"All the notebooks inside this notebook can be executed after properly setting the environment. 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",
"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\n",
"```\n",
"make env\n",
"```\n",
Expand All @@ -91,7 +92,7 @@
"\n",
"### How to cite 📖\n",
"\n",
"If you want to cite this work, please use this BibTex citation from [our latest preprint](https://gmd.copernicus.org/preprints/gmd-2023-120/):\n",
"If you want to cite this work, please use this BibTex citation from [our latest preprint](https://www.authorea.com/doi/full/10.22541/essoar.168881772.25833701):\n",
"```\n",
"@article{sapienza2023quantitative,\n",
" title={Quantitative Analysis of Paleomagnetic Sampling Strategies},\n",
Expand All @@ -103,7 +104,31 @@
"```\n",
"If you want to cite the software in this repository, you can instead use the following DOI in Zenodo:\n",
"\n",
"[![DOI](https://zenodo.org/badge/595793364.svg)](https://zenodo.org/badge/latestdoi/595793364)\n"
"[![DOI](https://zenodo.org/badge/595793364.svg)](https://zenodo.org/badge/latestdoi/595793364)\n",
"\n",
"\n",
"## Contributors\n",
"\n",
"<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n",
"<!-- prettier-ignore-start -->\n",
"<!-- markdownlint-disable -->\n",
"<table>\n",
" <tbody>\n",
" <tr>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://facusapienza.com\"><img src=\"https://avatars.githubusercontent.com/u/39526081?v=4?s=100\" width=\"100px;\" alt=\"Facundo Sapienza\"/><br /><sub><b>Facundo Sapienza</b></sub></a><br /><a href=\"#doc-facusapienza21\" title=\"Documentation\">📖</a> <a href=\"#code-facusapienza21\" title=\"Code\">💻</a> <a href=\"#infra-facusapienza21\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">🚇</a> <a href=\"#design-facusapienza21\" title=\"Design\">🎨</a> <a href=\"#maintenance-facusapienza21\" title=\"Maintenance\">🚧</a></td>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/LenGallo\"><img src=\"https://avatars.githubusercontent.com/u/29756069?v=4?s=100\" width=\"100px;\" alt=\"Leandro Gallo\"/><br /><sub><b>Leandro Gallo</b></sub></a><br /><a href=\"#code-LenGallo\" title=\"Code\">💻</a> <a href=\"#bug-LenGallo\" title=\"Bug reports\">🐛</a> <a href=\"#mentoring-LenGallo\" title=\"Mentoring\">🧑‍🏫</a> <a href=\"#design-LenGallo\" title=\"Design\">🎨</a> <a href=\"#question-LenGallo\" title=\"Answering Questions\">💬</a></td>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://www.swanson-hysell.org\"><img src=\"https://avatars.githubusercontent.com/u/4332322?v=4?s=100\" width=\"100px;\" alt=\"Nick Swanson-Hysell\"/><br /><sub><b>Nick Swanson-Hysell</b></sub></a><br /><a href=\"#review-Swanson-Hysell\" title=\"Reviewed Pull Requests\">👀</a> <a href=\"#doc-Swanson-Hysell\" title=\"Documentation\">📖</a> <a href=\"#design-Swanson-Hysell\" title=\"Design\">🎨</a> <a href=\"#mentoring-Swanson-Hysell\" title=\"Mentoring\">🧑‍🏫</a></td>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/matdomeier\"><img src=\"https://avatars.githubusercontent.com/u/40273197?v=4?s=100\" width=\"100px;\" alt=\"matdomeier\"/><br /><sub><b>matdomeier</b></sub></a><br /><a href=\"#ideas-matdomeier\" title=\"Ideas, Planning, & Feedback\">🤔</a> <a href=\"#design-matdomeier\" title=\"Design\">🎨</a></td>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://www.uu.nl/medewerkers/BVaes\"><img src=\"https://avatars.githubusercontent.com/u/94557078?v=4?s=100\" width=\"100px;\" alt=\"Bram Vaes\"/><br /><sub><b>Bram Vaes</b></sub></a><br /><a href=\"#design-bramvaes\" title=\"Design\">🎨</a> <a href=\"#ideas-bramvaes\" title=\"Ideas, Planning, & Feedback\">🤔</a></td>\n",
" <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://duserzym.github.io/\"><img src=\"https://avatars.githubusercontent.com/u/39976081?v=4?s=100\" width=\"100px;\" alt=\"Yiming Zhang\"/><br /><sub><b>Yiming Zhang</b></sub></a><br /><a href=\"#ideas-duserzym\" title=\"Ideas, Planning, & Feedback\">🤔</a></td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n",
"\n",
"<!-- markdownlint-restore -->\n",
"<!-- prettier-ignore-end -->\n",
"\n",
"<!-- ALL-CONTRIBUTORS-LIST:END -->\n"
],
"text/plain": [
"<IPython.core.display.Markdown object>"
Expand All @@ -118,6 +143,14 @@
"\n",
"display(Markdown(\"../README.md\"))"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "19167709-c961-4068-8026-f0d1fa320ff5",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit 904bb3b

Please sign in to comment.