Guidelines Epubs annual meeting: Difference between revisions

From CSDMS
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Guidelines Epubs=
=Guidelines Epubs=


Electronic publications (Epubs) are Jupyter notebooks that contain a scientific problem description and some findings that are investigated by numerical algorithms or models, that walks the reader through the science by executing the algorithms or models. The Epubs will be reviewed and can be part of a poster or oral presentation or separately submitted. Once excepted the Epub will get a DOI and will be made available through the CSDMS web.
Electronic publications (Epubs) are Jupyter notebooks that contain a scientific problem description and some findings that are investigated by numerical algorithms or one or more models, that walks the reader through the science by executing the algorithms or models. The Epubs will be reviewed and can be part of a poster or oral presentation or separately submitted. Once excepted the Epub will get a DOI and will be made available through the CSDMS web.


==Create a Jupyter Notebook==
==how to start==
Jupyter Notebook is a web application for creating and sharing computational documents. It offers a simple, streamlined, document-centric experience. [https://jupyter.org/install Learn more on how to install Jupyter Notebooks].  
* Set up a web repository: When developing your Jupyter notebook, it is good practice to start setting up a web repository for version control and sharing, e.g. by using [https://github.com/ GitHub]. There you can submit the updates to your notebook and include a user license. 
 
* Create a Jupyter Notebook: Jupyter Notebook is a web application for creating and sharing computational documents. It offers a simple, streamlined, document-centric experience. [https://jupyter.org/install Learn more on how to install Jupyter Notebooks].  
Your Jupyter Notebook should include:
* Preferable your Jupyter Notebook should include:
* Title
** Title
* Authors & affiliations
** Authors & affiliations
* Introduction
** Introduction
* Results
** Results
* Discussion ''(optional)''
** Discussion ''(optional)''
* Conclusions ''(optional)''
** Conclusions ''(optional)''
* Acknowledgements
*Acknowledgements ''(optional)''
* References
** References
 
==Set up a web repository==
GitHub is a code hosting platform for version control and collaboration


== How to submit your Jupyter Notebook ==
== How to submit your Jupyter Notebook ==
We'll reach out to you by email towards the end  
We'll reach out to you by email towards the end of March on how you share your repository.
== Your Jupyter Notebook should include ==
* Title
* Authors & affiliations
* Introduction
* Results
* Discussion ''(optional)''
* Conclusions ''(optional)''
* Acknowledgements
* References

Latest revision as of 09:58, 26 January 2023

Guidelines Epubs

Electronic publications (Epubs) are Jupyter notebooks that contain a scientific problem description and some findings that are investigated by numerical algorithms or one or more models, that walks the reader through the science by executing the algorithms or models. The Epubs will be reviewed and can be part of a poster or oral presentation or separately submitted. Once excepted the Epub will get a DOI and will be made available through the CSDMS web.

how to start

  • Set up a web repository: When developing your Jupyter notebook, it is good practice to start setting up a web repository for version control and sharing, e.g. by using GitHub. There you can submit the updates to your notebook and include a user license.
  • Create a Jupyter Notebook: Jupyter Notebook is a web application for creating and sharing computational documents. It offers a simple, streamlined, document-centric experience. Learn more on how to install Jupyter Notebooks.
  • Preferable your Jupyter Notebook should include:
    • Title
    • Authors & affiliations
    • Introduction
    • Results
    • Discussion (optional)
    • Conclusions (optional)
    • Acknowledgements (optional)
    • References

How to submit your Jupyter Notebook

We'll reach out to you by email towards the end of March on how you share your repository.