-
Notifications
You must be signed in to change notification settings - Fork 0
Rename and pixi #5
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
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9bf8791
change name of project
dylanmcreynolds bf1f352
support python 3.13
dylanmcreynolds 74a0b65
rename als_tiled to splash_tiled
dylanmcreynolds 26f7dc8
remove makefile
dylanmcreynolds 65be60f
add pixi configuration
dylanmcreynolds c0a07b0
Update README.md
dylanmcreynolds File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,18 +20,18 @@ This project provides a specialized Tiled server configuration for managing scie | |
|
|
||
| ```bash | ||
| # Build the Docker image | ||
| docker build -t als_tiled -f Containerfile . | ||
| docker build -t splash_tiled -f Containerfile . | ||
|
|
||
| # Run the container | ||
| docker run -p 8000:8000 als_tiled | ||
| docker run -p 8000:8000 splash_tiled | ||
| ``` | ||
|
|
||
| ### Local Development | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/als-lbl/als_tiled.git | ||
| cd als_tiled | ||
| git clone https://github.com/als-lbl/splash_tiled.git | ||
| cd splash_tiled | ||
|
|
||
| # Install in development mode | ||
| pip install -e .[dev] | ||
|
|
@@ -69,32 +69,54 @@ This installs additional development dependencies including: | |
|
|
||
| ## Development | ||
|
|
||
| ### Setting up the Development Environment | ||
|
|
||
| 1. Clone the repository: | ||
| ### Using Pixi for Development | ||
|
|
||
| This project supports [Pixi](https://pixi.sh/) for reproducible Python environments. Pixi handles dependency management and environment setup automatically. | ||
|
|
||
| #### Setting up with Pixi | ||
|
|
||
| 1. Install Pixi (if you don't have it): | ||
| ```bash | ||
| git clone https://github.com/als-lbl/als_tiled.git | ||
| cd als_tiled | ||
| curl -sSf https://pixi.sh/install.sh | bash | ||
| # Or see https://pixi.sh/docs/install/ for other methods | ||
| ``` | ||
|
|
||
| 2. Install development dependencies: | ||
| 2. Create and activate the development environment: | ||
| ```bash | ||
| pip install -e .[dev] | ||
| pixi install | ||
| pixi shell | ||
| ``` | ||
|
|
||
| 3. Install pre-commit hooks: | ||
| 3. (Optional) To update dependencies: | ||
| ```bash | ||
| pre-commit install | ||
| pixi update | ||
| ``` | ||
|
|
||
| #### Running Tests with Pixi | ||
|
|
||
| ```bash | ||
| pixi run test | ||
| ``` | ||
|
|
||
| #### Running Code Quality Checks with Pixi | ||
|
|
||
| ```bash | ||
| pixi run lint # Run all linters | ||
| pixi run format # Format code with black and isort | ||
| pixi run typecheck # Run mypy type checks | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| ``` | ||
|
|
||
| You can also run any tool in the environment with `pixi run <tool>` (e.g., `pixi run pytest`). | ||
|
|
||
| For more, see the [Pixi documentation](https://pixi.sh/docs/). | ||
|
|
||
| ### Running Tests | ||
|
|
||
| ```bash | ||
| # Run all tests | ||
| pytest | ||
|
|
||
| # Run tests with coverage | ||
| pytest --cov=als_tiled | ||
| pytest --cov=splash_tiled | ||
|
|
||
| # Run specific test file | ||
| pytest tests/test_main.py | ||
|
|
@@ -122,20 +144,20 @@ mypy src | |
| ### Building the Image | ||
|
|
||
| ```bash | ||
| docker build -t als_tiled -f .Containerfile . | ||
| docker build -t splash_tiled -f .Containerfile . | ||
| ``` | ||
|
|
||
| ### Running the Container | ||
|
|
||
| ```bash | ||
| # Basic run | ||
| docker run -p 8000:8000 als_tiled | ||
| docker run -p 8000:8000 splash_tiled | ||
|
|
||
| # With environment variables | ||
| docker run -p 8000:8000 -e TILED_SERVER_ENABLE_ORIGINS=* als_tiled | ||
| docker run -p 8000:8000 -e TILED_SERVER_ENABLE_ORIGINS=* splash_tiled | ||
|
|
||
| # With volume mounting for data | ||
| docker run -p 8000:8000 -v /path/to/data:/data als_tiled | ||
| docker run -p 8000:8000 -v /path/to/data:/data splash_tiled | ||
| ``` | ||
|
|
||
| ## CI/CD | ||
|
|
@@ -157,7 +179,7 @@ The project includes a comprehensive GitHub Actions workflow that: | |
|
|
||
| Docker images are automatically published to: | ||
| ``` | ||
| ghcr.io/als-lbl/als_tiled | ||
| ghcr.io/als-computing/splash_tiled | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
@@ -194,4 +216,4 @@ For support and questions, please open an issue on the GitHub repository or cont | |
| ## Related Projects | ||
|
|
||
| - [Tiled](https://github.com/bluesky/tiled) - The underlying framework | ||
| - [Bluesky](https://github.com/bluesky/bluesky) - Data acquisition and analysis framework# als_tiled | ||
| - [Bluesky](https://github.com/bluesky/bluesky) - Data acquisition and analysis framework# splash_tiled | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.