Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cyanxiao committed May 2, 2024
1 parent f4786f6 commit f3ee846
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ Midori is a plugin-based orchestrator that allows researchers to run software en

## 🚀 Getting Started

[Plugins](#what-are-these-plugins) and [experiment subject](#remote-node-and-experiment-subject-setup) are essential to conducting experiments with Midori. Plugins are used to interact with experiment subject or the remote cluster as a whole.

### Installation

Midori is only compatible with Python 3.12. Install it via pip or other package managers:

`pip install midori`

### Usage
Expand Down Expand Up @@ -50,9 +54,9 @@ orchestrator.run()

### Remote Node and Experiment Subject Setup

- The `subject_path` is a directory on the remote node.
- As mentioned in the next section, `variables` represent the variables to be manipulated in the experiment, which should be reflected in the `subject_path`.
- `subject_path` should be a git repository that contains branches named of the combinations of the `variables`. Each branch represents a treatment.
- The `subject_path` is a directory on the remote node. It is a valid experiment subject if
- It is a git repository.
- It contains branches named after the combinations of the `variables`. Each branch represents a treatment.

For example, if `variable` is

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "midori"
version = "1.0.2"
version = "1.0.3"
description = "🍃 streamline remote software engineering experiments"
authors = ["Xingwen Xiao <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit f3ee846

Please sign in to comment.