Skip to content

Commit

Permalink
refactor: remove Gitpod mechanism (#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
AngryMaciek authored Mar 9, 2024
1 parent def922b commit 445305a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 338 deletions.
25 changes: 0 additions & 25 deletions .gitpod.yml

This file was deleted.

14 changes: 0 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,6 @@ If you have an idea for improvement, you can submit your proposal in the *Issues

Please follow instructions specified in the [README](README.md#installation) file and you are good to code!

## Ephemeral development environment

You are more then welcome to contribute to our codebase from the cloud!
We set up an ephemeral [Gitpod](https://www.gitpod.io) environment for all the developers who prefer coding from a remote server.

Just click on this cool button below:
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/AngryMaciek/warlock)

See more information on how to start up a _Gitpod_ environment dedicated to a specific remote branch [here](https://www.gitpod.io/docs/introduction/learn-gitpod/context-url#branch-and-commit-contexts), specific issue [here](https://www.gitpod.io/docs/introduction/learn-gitpod/context-url#issue-context) and a specific pull request [here](https://www.gitpod.io/docs/introduction/learn-gitpod/context-url#pullmerge-request-context).

However, please remember that such luxury is limitted:
> Gitpod offers a free plan for new users which includes 50 hours of standard workspace usage.
>If you need more hours, you can upgrade to one of the paid plans in your personal settings.
## Branch naming convention

You can read about git branching [under this address](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging). The branch names should follow the convention specified below:
Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/AngryMaciek/warlock)
[![ci-pipeline](https://github.com/AngryMaciek/warlock/workflows/ci-pipeline/badge.svg)](https://github.com/AngryMaciek/warlock/actions?query=workflow%3Aci-pipeline)
[![CodeFactor](https://www.codefactor.io/repository/github/angrymaciek/warlock/badge/master)](https://www.codefactor.io/repository/github/angrymaciek/warlock/overview/master)
[![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://hub.docker.com/r/angrymaciek/warlock)
Expand Down Expand Up @@ -45,6 +44,11 @@ We have prepared a dedicated [conda environment](https://docs.conda.io/projects/
bash prepare-environments.sh
```

5. Finally, feel free to verify the installation with a small test script
```bash
bash testscript.sh
```

## Configuration

For a detailed description of all available simulation parameters please inspect [GitHub repository](https://github.com/robjohnnoble/demon_model) of the core _demon_ model.
Expand Down Expand Up @@ -117,12 +121,6 @@ Running large workflows with hundreds of cluster jobs might take very long; cons
After each pipeline run the main output directory will contain three subdirectories: `configfiles`, `simulations` and `logs`. Each simulation run with a specific set of parameters is encoded by a 4-letter code. The first directory contains configuration files for each of the simulation runs; `simulations` contain all _demon_ output files; `logs` keep captured standard output and error streams for the commands.
## Example
Feel free to run the pipeline and inspect the results yourself in an [interactive jupyter notebook](https://mybinder.org/v2/gh/AngryMaciek/warlock/master?labpath=notebook.ipynb) we prepared.
Alternatively, feel free to run a small test script on your local machine with
`bash testscript.sh`.
## Community guidelines
For guidelines on how to contribute to the project or report issues, please see [contributing instructions](/CONTRIBUTING.md).
For other inquires feel free to contact project lead by email: [✉️](mailto:wsciekly.maciek@gmail.com)
Expand Down
292 changes: 0 additions & 292 deletions notebook.ipynb

This file was deleted.

0 comments on commit 445305a

Please sign in to comment.