Skip to content

Latest commit

 

History

History
147 lines (103 loc) · 6.79 KB

README.md

File metadata and controls

147 lines (103 loc) · 6.79 KB
Raw

Introducing yt 3.0: Analysis and Visualization of Volumetric Data

HTML Manuscript PDF Manuscript Build Status

Manuscript description

This repository is the manuscript for a forthcoming, far-too-overdue paper on the additions in yt 3.0 since the release of the first yt paper in early 2011.

While this paper has "3.0" in the title, the authors are well-aware that it may not be completed before yt 4.0 has been released. We'll address that when or if it becomes important.

Authorship Policy

This paper has an inclusive authorship policy, by design. Authorship is not restricted to "yt project members" or to changeset authors.

If you would like to be an author on this paper, please follow these steps:

  1. Open a pull request adding yourself to content/metadata.yaml
  2. In that pull request, please indicate what components of the paper, if any, you are willing to write.
  3. If you are not interested in writing, editing or providing content for the paper, please indicate your involvement with yt.

This is not intended as a method of gatekeeping, but rather a mechanism for ensuring that authors have been at a bare minimum actively engaged in the development of the manuscript.

Please do not submit authorship requests on behalf of other individuals.

Author ordering will be determined prior to submission; at present, this will likely involve:

  • "The yt project" as first author on the paper.
  • A set of authors (order to be determined, but possibly random or alphabetical) that have contributed text or editing to the manuscript.
  • Other non-textual authors, similarly ordered.

A description of the authorship policy, when finalized, will be included in the manuscript.

We hope that this will provide the opportunity for an inclusive, extensive author list that still enables those contributing text to the manuscript to be credited as such.

Manubot

Manubot is a system for writing scholarly manuscripts via GitHub. Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub. The Manubot Rootstock repository is a general purpose template for creating new Manubot instances, as detailed in SETUP.md. See USAGE.md for documentation how to write a manuscript.

Please open an issue for questions related to Manubot usage, bug reports, or general inquiries.

Repository directories & files

The directories are as follows:

  • content contains the manuscript source, which includes markdown files as well as inputs for citations and references. See USAGE.md for more information.
  • output contains the outputs (generated files) from the manubot including the resulting manuscripts. You should not edit these files manually, because they will get overwritten.
  • webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
  • build contains commands and tools for building the manuscript.
  • ci contains files necessary for deployment via continuous integration. For the CI configuration, see .travis.yml.

Local execution

To run the Manubot locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands.

# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript
sh build/build.sh

# Or monitor the content directory, and automatically rebuild the manuscript
# when a change is detected.
sh build/autobuild.sh

# View the manuscript locally at http://localhost:8000/
cd webpage
python -m http.server

Continuous Integration

Build Status

Whenever a pull request is opened, Travis CI will test whether the changes break the build process to generate a formatted manuscript. The build process aims to detect common errors, such as invalid citations. If your pull request build fails, see the Travis CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the master branch occurs (for example, when a pull request is merged), Travis CI builds the manuscript and writes the results to the gh-pages and output branches. The gh-pages branch uses GitHub Pages to host the following URLs:

For continuous integration configuration details, see .travis.yml.

License

License: CC BY 4.0 License: CC0 1.0

Except when noted otherwise, the entirety of this repository is licensed under a CC BY 4.0 License (LICENSE.md), which allows reuse with attribution. Please attribute by linking to https://github.com/yt-project/yt-3.0-paper.

Since CC BY is not ideal for code and data, certain repository components are also released under the CC0 1.0 public domain dedication (LICENSE-CC0.md). All files matched by the following glob patterns are dual licensed under CC BY 4.0 and CC0 1.0:

  • *.sh
  • *.py
  • *.yml / *.yaml
  • *.json
  • *.bib
  • *.tsv
  • .gitignore

All other files are only available under CC BY 4.0, including:

  • *.md
  • *.html
  • *.pdf
  • *.docx

Except for the following files with different licenses:

Please open an issue for any question related to licensing.