Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created a quick get started tutorial using sphinx and GitHub actions … #30

Open
wants to merge 2 commits into
base: BalmorelEur
Choose a base branch
from

Conversation

TheisUM
Copy link
Collaborator

@TheisUM TheisUM commented Sep 23, 2024

…(#27)

  • Implemented tutorial format

  • Fixed wrong .yml path

  • Wrong build command fixed

  • Ample installation instructions

  • Added section on HPC running

  • Added installation instructions

  • Grammar

  • Correct path

  • Fixed headers and made a succesful admonition

  • Grammar

  • Itemisation doesn't need spaces between them

  • Access documentation

  • Some grammar

  • More installation instructions and project setup

  • Wrote scenario setup

  • Explained the scenario structure logic

  • Added addons page

  • Started running Balmorel page

  • Fixed links

  • Made a working test_run scenario

  • Finished running Balmorel section

  • There's now a minimal get started / 'hello world' guide for installing and running Balmorel, related to issue We should have a minimal get started guide for Balmorel on github pages #25

  • Corrected version and added general description

  • Added output analysis video

  • Added PuTTY login example

  • Made explanation for accessing WinSCP

  • Minimal guide to submitting jobs to the HPC finalised, related to issue We should have a minimal get started guide for Balmorel on github pages #25

  • Wrong wording

  • Added some notes on how to check the log

  • A link to the full documentation is made, which resolves We should have a minimal get started guide for Balmorel on github pages #25

  • Made copy button for code snippets

  • Trying to generate code snippets copy button again

  • Removed packages that did not exist, and trying with conda install copy button

  • Fixed copy button not appearing - needed to add is as extension in conf.py

  • Transferred the github action to master

  • Fixed some grammar error and added CLI description

…27)

* Implemented tutorial format

* Fixed wrong .yml path

* Wrong build command fixed

* Ample installation instructions

* Added section on HPC running

* Added installation instructions

* Grammar

* Correct path

* Fixed headers and made a succesful admonition

* Grammar

* Itemisation doesn't need spaces between them

* Access documentation

* Some grammar

* More installation instructions and project setup

* Wrote scenario setup

* Explained the scenario structure logic

* Added addons page

* Started running Balmorel page

* Fixed links

* Made a working test_run scenario

* Finished running Balmorel section

* There's now a minimal get started / 'hello world' guide for installing and running Balmorel, related to issue #25

* Corrected version and added general description

* Added output analysis video

* Added PuTTY login example

* Made explanation for accessing WinSCP

* Minimal guide to submitting jobs to the HPC finalised, related to issue #25

* Wrong wording

* Added some notes on how to check the log

* A link to the full documentation is made, which resolves #25

* Made copy button for code snippets

* Trying to generate code snippets copy button again

* Removed packages that did not exist, and trying with conda install copy button

* Fixed copy button not appearing - needed to add is as extension in conf.py

* Transferred the github action to master

* Fixed some grammar error and added CLI description
@Mathias157
Copy link
Contributor

Mathias157 commented Oct 11, 2024

Hi Theis, this will just add the markdown files (.md) for our new documentation at https://balmorelcommunity.github.io/Balmorel into your branch :) (As you can see, only added files).

You could merge this after an approval of the pull request #31, which includes some documentation on which branches exist and some more info in the Balmorel/base/documentation/gh-pages/README.md on how to write and test this documentation locally :)

* Added documentation on branches

* Updated the requirements in the readme for creating documentation

* Made oneliner explanations in overview section

* Made a link for the documentation in the README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants