Skip to content

Commit

Permalink
readme, mypy install
Browse files Browse the repository at this point in the history
  • Loading branch information
tjlane committed Oct 27, 2024
1 parent f030c9a commit 467c83b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/mypy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ jobs:
- name: mypy
run: |
pip install mypy
pip install .
pip install '.[tests]'
mkdir .mypy_cache
mypy --install-types --non-interactive meteor/ test/
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,20 @@ Map Enhancement Tools for Ephemeral Occupancy Refinement

`meteor` is currently **in beta**. We re-wrote everything recently, moving from a research code to something that can be robustly used as a tool. If you are willing to put up with a few sharp edges, it would be great if you give it a spin and then send us feedback: on how easy/not it was to use and what kinds of scientific results you obtain.

Finally: a word of caution. Expect changes in the coming weeks as we stress test the code. You might want to consider this before publishing any results with `meteor` until we exit `beta`.
Finally: a word of caution. Expect changes in the coming weeks as we stress test the code. You might want to consider this before publishing any results with `meteor` until we exit `beta`.

In that vein, for now please install the current master branch as per the following instructions. We'll have a sane
first stable version soon, which will be deployed straight to `PyPI` and `conda-forge`. Stay posted.

First, we recommend you make a new environment. For conda users,
```
conda create --name meteor python==3.11 --yes
conda activate meteor
```

Then install from github,
```
TODO: installation instructions
pip install git+https://github.com/alisiafadini/meteor
```

Once installed, you will have two command-line scripts. Ask for more info using `-h`:
Expand Down

0 comments on commit 467c83b

Please sign in to comment.