Merge pull request #60 from NREL/feature/workspace-dependency-cleanup

cleaned up workspace dependency structure

Author: calbaker

docs/src/developers.md

@@ -12,7 +12,7 @@ Clone the repository:
 1. Open git bash, and inside the directory you created,
    [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
    the [ALTRIOS repository](https://github.com/NREL/ALTRIOS) with e.g. `git clone
-   https://github.com/NREL/ALTRIOS.git`.
+https://github.com/NREL/ALTRIOS.git`.
 
 ## Installing the Python Package
 
@@ -65,52 +65,63 @@ tests pass. Also, be sure to rebuild the Python API regularly to ensure that it
 Python unit tests run with `python -m unittest discover` in the root folder of the git repository.
 
 ### With GitHub Actions
+
 Any time anyone pushes to `main` or does any pull request, the [GitHub Actions test
-workflows](https://github.com/NREL/altrios/tree/main/.github/workflows) are triggered.  
+workflows](https://github.com/NREL/altrios/tree/main/.github/workflows) are triggered.
 
 ## Releasing
 
 ### To PyPI With GitHub Actions
+
 To release the package with GitHub Actions, you can follow these steps:
 
 1. Create a new branch in the format `v<major>.<minor>.<patch>`, for example `v0.2.1`.
-1. Update the version number in the `pyproject.toml` file.  Commit and push to
-   https://github.com/NREL/altrios.  
+1. Update the version number in the `pyproject.toml` file. Commit and push to
+   https://github.com/NREL/altrios.
 1. Open a pull request into the main branch and make sure all checks pass.
 1. Once the pull request is merged into the main branch by a reviewer, create a new GitHub release
    and create a tag that matches the branch name. Once the release is created, a [GitHub
    action](https://github.com/NREL/altrios/blob/686e8c28828cb980cc45567d08091e69b7bee52c/.github/workflows/wheels.yaml#L5)
-   will be launched to build the wheels and publish them to PyPI. 
+   will be launched to build the wheels and publish them to PyPI.
 
 ### To crates.io
+
 #### altrios-core
+
 If you've updated `altrios-proc-macros`, be sure to publish that crate first and then update the
-Cargo.toml dependency for this crate.  
+Cargo.toml dependency for this crate.
+
+To release this crate, you need to be setup as developer for this crate in crates.io. Follow these steps:
 
-To release this crate, you need to be setup as developer for this crate in crates.io.  Follow these steps: 
 1. Increment the version number in
-   [rust/altrios-core/Cargo.toml](https://github.com/NREL/altrios/blob/main/rust/altrios-core/Cargo.toml).
+   [rust/altrios-core/Cargo.toml](https://github.com/NREL/altrios/blob/426f50e4ebd0fbf1d7e346aa31604107df8f83fe/rust/altrios-core/Cargo.toml#L8): 
+   
+   `version = "0.2.1"`.
 1. If changes were made in `altrios-proc-macros`, follow [the release process for that
    crate](#altrios-proc-macros) first, and then update the `altrios-proc-macros` dependency version
-   to match the new `altrios-proc-macros` version in `rust/altrios-core/Cargo.toml`.  
+   to match the new `altrios-proc-macros` version in `rust/altrios-core/Cargo.toml`.
 1. Run `git tag ac<major>.<minor>.<patch>`, where `ac<major>.<minor>.<patch>` should look like
    `ac0.1.4`, reflecting whatever the current version is.
 1. Push the tag with `git push public ac<major>.<minor>.<patch>`, where `public` is this remote:
    `[email protected]:NREL/altrios.git`.
 1. Run `cargo publish --dry-run` to make sure everything checks.
-1. Run `cargo publish` to release the update.  
+1. Run `cargo publish` to release the update.
 
-In the future, we may incorporate this into GitHub Actions.  
+In the future, we may incorporate this into GitHub Actions.
 
 #### altrios-proc-macros
-To release this crate, you need to be setup as developer for this crate in crates.io.  Follow these steps: 
+
+To release this crate, you need to be setup as developer for this crate in crates.io. Follow these steps:
+
 1. Increment the version number in
-   [rust/altrios-core/altrios-proc-macros/Cargo.toml](https://github.com/NREL/altrios/blob/main/rust/altrios-core/altrios-proc-macros/Cargo.toml).
+   [rust/Cargo.toml](https://github.com/NREL/altrios/blob/dced44b42c456da88363d03dc43259b039a94e6d/rust/Cargo.toml#L48):
+   
+   `altrios-proc-macros = { path = "./altrios-core/altrios-proc-macros", version = "0.2.0" }`.
 1. Run `git tag apm<major>.<minor>.<patch>`, where `apm<major>.<minor>.<patch>` should look like
    `apm0.1.4`, reflecting whatever the current version is.
 1. Push the tag with `git push public apm<major>.<minor>.<patch>`, where `public` is this remote:
    `[email protected]:NREL/altrios.git`.
 1. Run `cargo publish --dry-run` to make sure everything checks.
-1. Run `cargo publish` to release the update.  
+1. Run `cargo publish` to release the update.
 
-In the future, we may incorporate this into GitHub Actions.  
+In the future, we may incorporate this into GitHub Actions.

rust/Cargo.toml

@@ -1,7 +1,8 @@
 [workspace]
 members = [
-    "altrios-core", # pure rust core with optional pyo3 feature
-    "altrios-py",   # python module exposing altrios-core
+    "altrios-core",                     # pure rust core with optional pyo3 feature
+    "altrios-core/altrios-proc-macros", # proc macros for altrios-core
+    "altrios-py",                       # python module exposing altrios-core
 ]
 resolver = "2"
 
@@ -41,3 +42,7 @@ polars-lazy = { version = "0.32" }
 pyo3-polars = { version = "0.6" }
 uom = { version = "0.35.0", features = ["use_serde"] }
 eng_fmt = "0.1.2"
+
+# local crates in this workspace
+altrios-core = { path = "./altrios-core" }
+altrios-proc-macros = { path = "./altrios-core/altrios-proc-macros", version = "0.2.0" }

rust/altrios-core/Cargo.toml

@@ -17,7 +17,7 @@ serde_json = "1.0"
 uom = { workspace = true }
 paste = "1.0.7"
 easy-ext = "1.0.0"
-altrios-proc-macros = { version = "0.2.0", path = "altrios-proc-macros" }
+altrios-proc-macros = { workspace = true }
 argmin = "0.5.1"
 rayon = "1.5.3"
 bincode = "1.3.3"

rust/altrios-py/Cargo.toml

@@ -10,7 +10,7 @@ version = "0.1.0"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-altrios-core = { path = "../altrios-core", features = ["pyo3"] }
+altrios-core = { workspace = true, features = ["pyo3"] }
 pyo3 = { workspace = true, features = ["extension-module", "anyhow"] }
 pyo3-log = { workspace = true }
 polars = { workspace = true }