A project template for writing papers to the MNRAS Journal
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
astropy-helpers @ 86f1159
docs
hooks
tests
{{ cookiecutter.repo_name }}
.gitignore
.gitmodules
.rtd-environment.yml
CHANGES.rst
LICENSE
README.md
ah_bootstrap.py
cookiecutter.json
readthedocs.yml
requirements.txt
setup.cfg

README.md

Documentation Status License GitHub issues PDF latest

Cookiecutter - Template for MNRAS Paper

An easy, reasonably standardized, but flexible template for creating paper for the Monthly Notices of the Royal Astronomical Society.

Requirements to use the cookiecutter template


  • Python 2.7 or 3.5 and above
  • Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
$ pip install cookiecutter

or

$ conda config --add channels conda-forge
$ conda install cookiecutter

To start a new project, run:


cookiecutter https://github.com/vcalderon2009/MNRAS_Cookiecutter

For an example on how to properly do this, see the following video. It serves as a demonstration on how cookiecutter works.

asciicast

The resulting directory structure


The directory structure of your new project looks like this:

├── Extras <- Folder with documents like main `aliases`, `packages`, etc.
│    ├── commands.tex <- List of commands used throughout the paper.
│    └── packages.tex <- List of packages to load for the paper.
│
├── Figures <- Directory for project figures.
│    └── .gitkeep
│
├── Paper
│    ├── mnras.bst                             <-- MNRAS bibliography style file.
│    ├── mnras.cls                             <-- MNRAS class file.
│    └── paper.tex                             <- Main TeX file for compiling.
│
├── Script_files
│    ├── modify_bib.sh
│    ├── hyperlink-year-only-natbib-patch.tex. <- File that fixed the bibliography style.
│    └── nat2jour.pl
│
├── Section_files
│   ├── 01_abstract.tex                        <-- File for the 'abstract'.
│   ├── 02_introduction.tex                    <-- File for the 'Introduction'.
│   ├── 03_data_methods.tex                    <-- File for the 'Data and Methods'.
│   ├── 04_results.tex                         <-- File for the 'Results'.
│   ├── 05_summary_discussion.tex              <-- File for the 'Summary and Discussion'.
│   └── 06_acknowledgements.tex                <-- File for the 'Acknowledgements'.
│
├── .gitignore                                 <- File that dictates which files to ignore when using `git`.
├── Makefile                                   <- Makefile with command, i.e. `make main.tex` or `make clean`
├── Makefile.inc                               <- File with input parameters for the `Makefile`.
├── Mendeley.bib                               <- Bibliography of the project. You can replace this file if needed.
├── README.md                                  <- The top-level README for students
├── LICENSE                                    <- License used for the distribution of the paper.
└── requirements.txt                           <- File with a list of packages required for running this.

Contributing

Contributions are welcomed! If you have any suggestions, feel free to submit a Pull Request.

Installing development requirements


pip install -r requirements.txt