-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adding logo * update logo and some minor edits * update syles * update submission guidelines * adding pip * completed how to cite * update bibliography instructions * adding submission guidelines * updates * adding SEA Logo
- Loading branch information
Showing
9 changed files
with
240 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,86 @@ | ||
| # How to Use This Template 🛠️ | ||
|
|
||
| **Estimated submission time: 30 minutes** | ||
|
|
||
| **This page includes the submission guidelines of SEA 2024 conference.** | ||
|
|
||
| ## Create your Paper Repository | ||
|
|
||
| 1. **Create a New Repository Using this Template**: Click on the "Use this template" button to create a new repository with the files from this template. | ||
|  | ||
|
|
||
| 2. **Name your Repository**: Name your repository using the following naming convention: `SEA-ISS-2024-<paper-title>`. For example, if your paper title is "My Awesome Paper", your repository name should be `SEA-ISS-2024-My-Awesome-Paper`. | ||
|
|
||
| 3. **Activate GitHub Pages**: Once you created your repository, go to the settings of your repository, scroll down to the "Pages" section, and under "Build and deployment" choose Source: "GitHub Actions". This will allow you to view your Jupyter Book online. This will be automatically triggered when you push your changes to your repository. Once you activate this, you can view your Jupyter Book by clicking on the link provided in the "Pages" section of your repository settings. | ||
| 3. **Activate GitHub Pages**: Once you created your repository, go to the settings of your repository, scroll down to the "Pages" section, and under "Build and deployment" choose Source: "GitHub Actions". This will allow you to view your Jupyter Book online. | ||
| This will be automatically triggered when you push your changes to your repository. Once you activate this, you can view your Jupyter Book by clicking on the link provided in the "Pages" section of your repository settings. | ||
|
|
||
| 4. **Environment Setup**: Update the `environment.yml` file and add any additional packages you may require. | ||
|
|
||
| 5. **Paper Information**: Fill in the details of your paper in this `README.md`, including the title, authors, abstract, and other relevant acknowledgements. At this step, don't worry about the DOI badge, you will update this later. | ||
|
|
||
| 6. **Add your Paper**: Add your paper as Jupyter Notebooks or markdown files under the `notebooks` folder. You can use one notebook or multiple notebooks if you wish. You can also use markdown files if you prefer. | ||
|
|
||
| ``` | ||
| notebooks/ | ||
| |── introduction.md | ||
| ├── notebook1.ipynb | ||
| └── notebook2.ipynb | ||
| ``` | ||
| ``` | ||
| notebooks/ | ||
| |── introduction.md | ||
| ├── notebook1.ipynb | ||
| └── notebook2.ipynb | ||
| ``` | ||
|
|
||
| This framework supports [the MyST Markdown language](https://jupyterbook.org/en/stable/reference/glossary.html#term-MyST) in Markdown and notebook documents. This allows users to write rich, publication-quality markup in their documents. | ||
|
|
||
| 5. **Update the Table of Contents**: Update the `toc.yml` file to include the notebooks you've added. | ||
| This framework supports [the MyST Markdown language](https://jupyterbook.org/en/stable/reference/glossary.html#term-MyST) in Markdown and notebook documents. This allows users to write rich, publication-quality markup in their documents. | ||
|
|
||
| 7. **Update the Table of Contents**: Update the `toc.yml` file to include the notebooks you've added. | ||
|
|
||
| 6. **Remove Instructions**: Once you've set up your repository, delete these instructions. | ||
| 8. **Remove Instructions**: Once you've set up your repository, delete these instructions. | ||
|
|
||
| 9. **Commit your changes**: Commit and push your changes to your repository. | ||
|
|
||
| 7. **Commit your changes**: Commit and push your changes to your repository. | ||
| 10. **Check your Jupyter Book**: Once you've pushed your changes, check that your Jupyter Book is building correctly. You can check the status of your Jupyter Book by clicking on the "Actions" tab of your repository. | ||
|
|
||
| 8. **Check your Jupyter Book**: Once you've pushed your changes, check that your Jupyter Book is building correctly. You can check the status of your Jupyter Book by clicking on the "Actions" tab of your repository. | ||
| ```{tip} | ||
| **Citations and Bibliography**: For adding citations to your paper and referencing others, please see our detailed guidelines [here](notebooks/notebook-example2_references.md). In short, after adding your references to your `references.bib` file, you can add the citation to your paper using the `{cite}[authoryearkey]` syntax. | ||
| ``` | ||
|
|
||
| ## Ready to Submit your Paper? 📝 | ||
|
|
||
| 9. **Submit your Paper:** Once you've completed the steps above, you can submit your paper to the conference organizers: | ||
| 11. **Submit your Paper:** Once you've completed the steps above, you can submit your paper to the conference organizers: | ||
| * Once you are ready to submit your paper, go to the "Issues" tab of this repository and [click "New Issue"](https://github.com/UCAR-SEA/SEA-ISS-Template/issues/new). | ||
| * Someone from the SEA committee will add your github username to the list of collaborators for the UCAR-SEA github organization. | ||
| * Once you accepted the invitation, you can transfer your repository to the UCAR-SEA organization. | ||
| * Navigate to the settings of your paper repository, scroll down to the Danger Zone, and click "Transfer" . | ||
| * Select or type "UCAR-SEA" to transfer the repository to the conference organizers. This step will make your paper public and allow the conference organizers to review your paper. | ||
|
|
||
| ## Make Zenodo DOI for your paper | ||
| ### Make Zenodo DOI for your paper | ||
|
|
||
| 10. **Make Zenodo DOI for your paper:** Once you've completed the steps above, you can make Zenodo DOI for your paper: | ||
| 12. **Make Zenodo DOI for your paper:** Once you've completed the steps above, you can make Zenodo DOI for your paper: | ||
|
|
||
| * Go to [Zenodo](https://zenodo.org/) and login with your GitHub account. | ||
| * Click on "New Upload" and select your paper repository. | ||
| * You need to first create a new release for your paper repository. Click on "Create a new release" and add the version number of your paper. For example, if this is the first version of your paper, you can add "v1.0.0" as the version number. | ||
| * Once you've created a new release, you can go back to the "New Upload" page and select the version of your paper and create a new DOI for your paper. | ||
| * Go to [Zenodo](https://zenodo.org/) and login with your GitHub account. | ||
| * Click on "New Upload" and select your paper repository. | ||
| * You need to first create a new release for your paper repository. Click on "Create a new release" and add the version number of your paper. For example, if this is the first version of your paper, you can add "v1.0.0" as the version number. | ||
| * Once you've created a new release, you can go back to the "New Upload" page and select the version of your paper and create a new DOI for your paper. | ||
|
|
||
| 11. **Update the DOI badge**: Once you've created a new DOI for your paper, you can update the DOI badge in the README.md file of your paper repository with the new DOI. | ||
| 13. **Update the DOI badge**: Once you've created a new DOI for your paper, you can update the DOI badge in the README.md file of your paper repository with the new DOI. | ||
|
|
||
| ## Configure Binder for your paper: | ||
|
|
||
| 12. **Update or remove the Binder badge**: | ||
| **Update or remove the Binder badge** | ||
|
|
||
| * For those who would like their papers to be easily launched in an executable environment based upon the specifications in the repository, you can update the Binder badge in the README.md to appropriately reflect your repository name and path to your notebooks. You can find more information about how this works on the [My Binder website](https://mybinder.org/). | ||
| * If your notebooks are not interative or you would rather not include this feature, simply remove the line for the Binder badge in the README.md file. | ||
|
|
||
|
|
||
| ----------------- | ||
| You can submit your paper as one notebook or split it up to multiple notebooks and markdown files. Please see the [example paper1](notebooks/notebook-template) and [example paper2](notebooks/notebook-example2_part1) for examples of how to structure your paper. | ||
|
|
||
|
|
||
| ```{tip} | ||
| You can submit your paper as one notebook or split it up to multiple notebooks and markdown files. Please see the [example paper1](notebooks/notebook-template) and [example paper2](notebooks/notebook-example2_part1) for examples of how to structure your paper. | ||
| ``` | ||
|
|
||
| ```{note} | ||
| For your submissions, please use the following naming convention for your paper repository: `SEA-ISS-2024-<paper-title>`. For example, if your paper title is "My Awesome Paper", your repository name should be `SEA-ISS-2024-My-Awesome-Paper`. | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|