Skip to content

Update README.md#8

Merged
lanery merged 2 commits intomainfrom
rl/update-readme
Feb 13, 2025
Merged

Update README.md#8
lanery merged 2 commits intomainfrom
rl/update-readme

Conversation

@lanery
Copy link
Copy Markdown
Collaborator

@lanery lanery commented Feb 5, 2025

Description

  • Update the README to more accurately reflect what the package is made for and capable of.
  • Update install directions now that repo is public (can now install from the repo directly via pip install git+<repo url>.

Considered building it and releasing it, but not sure if it's ready for that? Would be cool if it were automated!

@lanery lanery requested a review from ekiefl February 5, 2025 22:21
Copy link
Copy Markdown
Contributor

@ekiefl ekiefl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recently wiped my conda envs and started fresh, so I had the opportunity of recreating the development environment for this repo. Everything worked as intended, except there's currently no developer installation instructions, and I think there should be.

  conda env create -n ramanalysis-dev --file envs/dev.yml
conda activate  ramanalysis-dev
poetry install --no-root --with dev,docs,build
pip install -e .
make test

Everything ran without error 👍.


In the example I think you should assume your CWD is the repo root, making the path:

example_data_directory = Path("./ramanalysis/tests/example_data/OpenRAMAN/")

- change example data directory path in usage example as suggested in #8
@lanery lanery merged commit 029a089 into main Feb 13, 2025
@lanery lanery deleted the rl/update-readme branch February 13, 2025 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants