https://github.com/nicolossus/numerical-project-template
Template for numerical projects with report
https://github.com/nicolossus/numerical-project-template
Last synced: 3 months ago
JSON representation
Template for numerical projects with report
- Host: GitHub
- URL: https://github.com/nicolossus/numerical-project-template
- Owner: nicolossus
- Created: 2019-10-12T10:55:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-12T12:02:08.000Z (over 5 years ago)
- Last Synced: 2025-01-14T01:34:37.008Z (4 months ago)
- Language: Jupyter Notebook
- Size: 4.34 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Warning:** filenames that contains string 'example' will be deleted when `clean_examples.sh` is run.
# Project X
This repository contains programs made for project X
### Structure
The [latex folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/latex) contains the LaTeX source for building the report, as well as [figures](https://github.com/nicolossus/Numerical-Project-Template/tree/master/latex/figures) and [tables](https://github.com/nicolossus/Numerical-Project-Template/tree/master/tables) generated in the analyses.
The [notebooks folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/notebooks) contains Jupyter notebooks used in the analyses. For details, see the [notebooks readme](https://github.com/nicolossus/Numerical-Project-Template/blob/master/notebooks/README.md).
The [report folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/report) contains the report rendered to PDF from the LaTeX source.
The [resources folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/resources) contains project resources such as raw data to be analysed.
The [src folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/src) contains the source code. For details, see the [src readme](https://github.com/nicolossus/Numerical-Project-Template/blob/master/src/README.md).
The [test folder](https://github.com/nicolossus/Numerical-Project-Template/tree/master/test) contains procedures for unit testing and [benchmarking](https://github.com/nicolossus/Numerical-Project-Template/tree/master/test/benchmark) the source code developed for the project.
### Usage
To compile, test, benchmark and reproduce all results, `cd` into project and run `bash run.sh` in terminal.