search

nmfs-ost / ss3-doc

Source code for the Stock Synthesis manual and other documentation
https://nmfs-ost.github.io/ss3-website/
Creative Commons Zero v1.0 Universal
4 stars 3 forks source link
latex stock-synthesis

readme

ss3-doc

Source code for the Stock Synthesis (SS3) manual and other supplementary documentation.

What documentation is available in this repository?

The documentation includes:

Where can I find compiled versions of the documentation?

See the ss3 website for links to a PDF and HTML version of the compiled documentation from the latest Stock Synthesis release. If you would like a more detailed list of changes to Stock Synthesis in the most recent release, please see the Stock Synthesis change log.

PDF versions of the user manual are also available in the ss3 manuals folder on the vlab website.

The contributing guide contains information on how to compile locally or with github actions.

How can I report bugs or suggest changes to the ss3 documentation?

Please open an issue or submit a pull request.

Where should I ask a question about Stock Synthesis?

If you have a question related to Stock Synthesis, please post an issue in the Stock Synthesis GitHub repository for model questions or ask it on the Stock Synthesis forums. If you have a question about the manual, please post an issue in the Stock Synthesis documentation GitHub repository, or email it to the Stock Synthesis team at nmfs.stock.synthesis@noaa.gov.

How can I contribute to the Stock Synthesis documentation?

Please feel free to suggest changes by opening an issue or submitting a pull request! We also welcome your ideas for other helpful resources that could be created to help users learn Stock Synthesis.

For complete details, please see CONTRIBUTING.md.

How to cite the Stock Synthesis manual

Methot, R. D., Jr., C. R. Wetzel, I. G. Taylor, and K. Doering. 2020. Stock Synthesis User Manual Version 3.30.15. U.S. Department of Commerce, NOAA Processed Report NMFS-NWFSC-PR-2020-05. https://doi.org/10.25923/5wpn-qt71

The following BibTeX entry can be copied and used in a .bib file:

@techreport{methot2020stock,
  title={Stock Synthesis User Manual: Version 3.30.15},
  author={Methot, Richard Donald and Wetzel, Chantel R and Taylor, Ian G and Doering, Kathryn L},
  year={2020}, 
  institution={U.S. Department of Commerce},
  type={NOAA Processed Report Series NMFS-NWFSC-PR-2020-05},
  doi={10.25923/5wpn-qt71},
}

Disclaimer

“The United States Department of Commerce (DOC) GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.”

NOAA Fisheries

U.S. Department of Commerce | National Oceanographic and Atmospheric Administration | NOAA Fisheries