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

Wiki contribution: Add a guide on how to use the scripts #186

Closed
4 of 5 tasks
2320sharon opened this issue Aug 22, 2023 · 1 comment
Closed
4 of 5 tasks

Wiki contribution: Add a guide on how to use the scripts #186

2320sharon opened this issue Aug 22, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation V2 for version 2 of coastseg

Comments

@2320sharon
Copy link
Collaborator

2320sharon commented Aug 22, 2023

The scripts in coastseg aren't included in the pip package. Make sure to add them and create a guide on how to use them so that users can use them

  • Add the scripts to the official pypi package
  • Fix the scripts so that they work on the new transects in issue US slope database #134
  • Fix the scripts so that they work on regular transects files
  • Add a guide on how to run the scripts
  • Add a guide on how to open each script in python in notepad ++
@2320sharon 2320sharon added the documentation Improvements or additions to documentation label Aug 22, 2023
@2320sharon 2320sharon self-assigned this Aug 22, 2023
@2320sharon 2320sharon added the V1 Version 1 of Coastseg label Aug 24, 2023
2320sharon added a commit that referenced this issue Aug 29, 2023
2320sharon added a commit that referenced this issue Aug 29, 2023
@2320sharon
Copy link
Collaborator Author

It turns how including executable scripts in the pip package is not as simple as just adding the scripts directory to the MANIFEST.in. My initial research leads me to believe this will take a bit more work to configure correctly. I may to modify the pyproject.toml and setup.py files to make all the scripts runnable from the command line.

In the meantime all the scripts are now functioning and can be acquired by running a git pull command

@2320sharon 2320sharon added V2 for version 2 of coastseg and removed V1 Version 1 of Coastseg labels Sep 7, 2023
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 V2 for version 2 of coastseg
Projects
None yet
Development

No branches or pull requests

1 participant