Hosting on GitHub
GitHub is a code hosting and collaboration platform which lends itself naturally to publishing your experiment code as Open Source. In addition to hosting source code, GitHub also allows hosting websites using its GitHub Pages feature.
Magpie's project template (the one you get, when running
magpie new) already contains a working GitHub Workflow for deploying to GitHub Pages.
This means, when you push your project to GitHub, it will automatically build the experiment and commit the output
gh-pages branch for you. Once you enable GitHub Pages for your repository, GitHub will make the latest version of the
branch available publicly at
https://<username>.github.io/<repo-name>/. As you commit new changes to your main branch,
the workflow will keep your
gh-pages branch up-to-date.
(available for experiments created with magpie-base v3.5.0 or newer)
If you'd like to host multiple experiments in the same repository, you can put those experiments in separate sub-folders and list those subfolders in the matrix of the Github Workflow:
name: Build and Deploy on: push: branches: - main - master jobs: build-and-deploy: strategy: matrix: folder: - ./ # ...
By default the Github Workflow will only publish the experiment in the root folder of the repository:
If you have your experiments in different folders you can simply change the list here:
strategy: matrix: folder: - experiments/pilot-01/ - experiments/main/ # ...
The experiments will then be hosted at