Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
CADET-RDM
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
IBG-1
ModSim
CADET
CADET-RDM
Commits
7857538e
Commit
7857538e
authored
1 year ago
by
Ronald Jäpel
Browse files
Options
Downloads
Patches
Plain Diff
update README.md
parent
f9a26ae9
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+24
-5
24 additions, 5 deletions
README.md
with
24 additions
and
5 deletions
README.md
+
24
−
5
View file @
7857538e
...
@@ -26,9 +26,9 @@ initialize_repo(path_to_repo)
...
@@ -26,9 +26,9 @@ initialize_repo(path_to_repo)
The `output_folder_name` can be given optionally. It defaults to `output`.
The `output_folder_name` can be given optionally. It defaults to `output`.
##
#
Use CADET-RDM in Python
## Use CADET-RDM in Python
###
#
Tracking Results
### Tracking Results
```
python
```
python
from cadetrdm import ProjectRepo
from cadetrdm import ProjectRepo
...
@@ -58,7 +58,7 @@ if __name__ == '__main__':
...
@@ -58,7 +58,7 @@ if __name__ == '__main__':
```
```
###
#
Sharing Results
### Sharing Results
To share your project code and results with others, you need to create remote repositories on e.g.
To share your project code and results with others, you need to create remote repositories on e.g.
[GitHub](https://github.com/) or GitLab. You need to create a remote for both the _project_ repo and the
[GitHub](https://github.com/) or GitLab. You need to create a remote for both the _project_ repo and the
...
@@ -87,7 +87,7 @@ command
...
@@ -87,7 +87,7 @@ command
repo.push()
repo.push()
```
```
###
#
Re-using results from previous iterations
### Re-using results from previous iterations
Each result stored with CADET-RDM is given a unique branch name, formatted as:
Each result stored with CADET-RDM is given a unique branch name, formatted as:
`<timestamp>_<output_folder>_"from"_<active_project_branch>_<project_repo_hash[:7]>`
`<timestamp>_<output_folder>_"from"_<active_project_branch>_<project_repo_hash[:7]>`
...
@@ -106,7 +106,26 @@ the correct branch name from the path to the file within the cache
...
@@ -106,7 +106,26 @@ the correct branch name from the path to the file within the cache
cached_array_path = repo.input_data(source_file_path="output_cached/
<branch_name>
/raw_data/data.csv")
cached_array_path = repo.input_data(source_file_path="output_cached/
<branch_name>
/raw_data/data.csv")
```
```
### Using results from another repository
## Use CADET RDM from the CLI
### Executing scripts
You can execute python files or arbitray commands using the CLI:
```
bash
cd path/to/your/project
cadet-rdm run-python-file
<path
/
to
/
file
>
"commit message for the results"
cadet-rdm run-command "command as it would be run" "commit message for the results"
```
For the run-command option, the command must be given in quotes, so:
```
bash
cadet-rdm run-command "python example_file.py" "commit message for the results"
```
#### Using results from another repository
You can load in results from another repository to use in your project using the CLI:
You can load in results from another repository to use in your project using the CLI:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment