|
1 | 1 | # ezplot |
2 | 2 |
|
3 | | -[](https://img.shields.io/github/v/release/phuongho43/ezplot) |
4 | | -[](https://github.com/phuongho43/ezplot/actions/workflows/main.yml?query=branch%3Amain) |
5 | | -[](https://codecov.io/gh/phuongho43/ezplot) |
6 | | -[](https://img.shields.io/github/commit-activity/m/phuongho43/ezplot) |
7 | | -[](https://img.shields.io/github/license/phuongho43/ezplot) |
8 | | - |
9 | 3 | Visualizing data from biology experiments. |
10 | 4 |
|
11 | | -- **Github repository**: <https://github.com/phuongho43/ezplot/> |
12 | | -- **Documentation** <https://phuongho43.github.io/ezplot/> |
13 | | - |
14 | | -## Getting started with your project |
15 | | - |
16 | | -### 1. Create a New Repository |
| 5 | +## Getting Started |
17 | 6 |
|
18 | | -First, create a repository on GitHub with the same name as this project, and then run the following commands: |
| 7 | +### 1. Install [UV](https://docs.astral.sh/uv/getting-started/installation/) |
19 | 8 |
|
20 | 9 | ```bash |
21 | | -git init -b main |
22 | | -git add . |
23 | | -git commit -m "init commit" |
24 | | -git remote add origin git@github.com:phuongho43/ezplot.git |
25 | | -git push -u origin main |
| 10 | +$ curl -LsSf https://astral.sh/uv/install.sh | sh |
26 | 11 | ``` |
27 | 12 |
|
28 | | -### 2. Set Up Your Development Environment |
29 | | - |
30 | | -Then, install the environment and the pre-commit hooks with |
31 | | - |
32 | | -```bash |
33 | | -make install |
34 | | -``` |
35 | | - |
36 | | -This will also generate your `uv.lock` file |
37 | | - |
38 | | -### 3. Run the pre-commit hooks |
| 13 | +### 2. Specify file paths and plotting parameters |
39 | 14 |
|
40 | | -Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run: |
| 15 | +ezplot/plot\_[type].py |
41 | 16 |
|
42 | | -```bash |
43 | | -uv run pre-commit run -a |
44 | | -``` |
45 | | - |
46 | | -### 4. Commit the changes |
47 | | - |
48 | | -Lastly, commit the changes made by the two steps above to your repository. |
| 17 | +### 3. Run plotting functions |
49 | 18 |
|
50 | 19 | ```bash |
51 | | -git add . |
52 | | -git commit -m 'Fix formatting issues' |
53 | | -git push origin main |
| 20 | +$ uv run plot_[type] |
54 | 21 | ``` |
55 | | - |
56 | | -You are now ready to start development on your project! |
57 | | -The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release. |
58 | | - |
59 | | -To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi). |
60 | | -For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github). |
61 | | -To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/). |
62 | | - |
63 | | -## Releasing a new version |
64 | | - |
65 | | ---- |
66 | | - |
67 | | -Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv). |
0 commit comments