Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Packaging #10

Merged
merged 4 commits into from
Feb 26, 2024
Merged

Packaging #10

merged 4 commits into from
Feb 26, 2024

Conversation

jatkinson1000
Copy link
Member

@jatkinson1000 jatkinson1000 commented Feb 19, 2024

This pull request closes #3 which is associated with packaging.

The result of this PR is that the repository can be cloned from GitHub, and then you can run:

pip install .

to install all of the dependencies in one go.
Currently you are required to infer the required dependencies from looking at the code.

It will also install as a package into python with associated metadata (see the pyproject.toml file).

To do this I have:

  • Moved the python code into a 'package' file
  • added a pyproject.toml
  • updated filepaths in train.py to reflect the fact the location of Demodata/ is outside the package file at top-level
    • Other areas of the code may need updating in due course.
  • Added a (basic) pip installation instructions added to README.md

@jatkinson1000 jatkinson1000 self-assigned this Feb 19, 2024
@jatkinson1000 jatkinson1000 added documentation Improvements or additions to documentation enhancement New feature or request Python-repo Part of the python NN repo labels Feb 19, 2024
@jatkinson1000
Copy link
Member Author

This is currently set up as a package, even though things are designed to be run as standalone scripts at the moment.
In future it may be the case that 'proper' packaging is required to allow importing of certain modules/functions. See e.g. #5

For now this allows easy installation of all dependencies in one command when moving to a new machine or environment.

Copy link
Collaborator

@surbhigoel77 surbhigoel77 left a comment

Choose a reason for hiding this comment

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

Looks good to me @jatkinson1000.

@jatkinson1000 jatkinson1000 merged commit 5a4efa7 into main Feb 26, 2024
@jatkinson1000 jatkinson1000 deleted the packaging branch February 26, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Python-repo Part of the python NN repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Package project for easy installation
3 participants