Added Docker files for development environment. #2569
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
This is a proposal to generate a development environment to easily configure and launch TARDIS with Conda and Mamba. This development environment downloads the repositories as “data reference” and “atomic data”. Beyond this, you can run TARDIS, unit tests with PyTest and benchmarks with ASV.
Note: I keep this pull request as a draft because I believe that it needs to be discussed with the owners and maintainers of TARDIS.
Type: 🚀
feature
All the information is in this YouTube video with the walkthrough about the different flavors of the development environment, its usages and cons.
I tried to install all the requirements, and I noticed that it is quite of difficult and some packages were installed as Conda. I would rather not mix my personal environment with the TARDIS development environment. For this reason, I created a series of Docker processes to have 3 types of environment: one for static code in the container, another fragmented (mixed) and the total live which means use your local computer (host) to take and store files.
To see more references, check the file:
Dockerfile-benchmarks.bash
. Furthermore, one video is better thatn ten thousand of words; I created a YouTube video explaining this development environment usage.Docker
Static
Pros:
Cons:
Fragmented
Pros:
Cons:
Live
Pros:
Cons:
📌 Resources
N/A
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docs
label