-
Notifications
You must be signed in to change notification settings - Fork 354
Why Rez doc page #1967
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
Open
BryceGattis
wants to merge
3
commits into
AcademySoftwareFoundation:main
Choose a base branch
from
BryceGattis:feature/why_rez_doc_page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Why Rez doc page #1967
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| ======= | ||
| Why Rez | ||
| ======= | ||
|
|
||
| What is Rez | ||
| =========== | ||
|
|
||
| Rez v1 was originally built in 2011 by Allan Johns and was open-sourced in 2013. | ||
|
|
||
| It was with VFX/Animation workflows in mind, where different productions can have non-homogenous package | ||
| requests and shared filesystems are the norm. | ||
|
|
||
| Rez is both a package manager and an environment manager. | ||
|
|
||
| Package Manager | ||
| --------------- | ||
|
|
||
| A package manager is a tool that helps keep track of an application's dependencies. Package managers provide | ||
| often communicate with package repositories to install, update and remove packages on a computer. | ||
|
|
||
|
|
||
| Environment Manager | ||
| ------------------- | ||
|
|
||
| A runtime environment manager is a tool that allows users to easily control what a shell created environment | ||
| will look like. This primarily takes shape by defining environment variables that will then be used by | ||
| applications that are launched from the created shell. | ||
|
|
||
|
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. It would be useful to have an simple example here. Something like launching an environment that sets all the environment variables for maya to find the required plugins for a show and setting the alises for a user to launch maya. |
||
|
|
||
| What Rez is not | ||
| =============== | ||
| Rez is not a configuration system. It does not and should not have any knowledge as to the content of a user's | ||
| package requests. | ||
|
|
||
| In VFX/Animation for example, a common problem is that different projects or "shows" may need to use different | ||
| versions of software/tools. This is especially problematic with long-standing productions such as feature films. | ||
|
|
||
| Let's say there are two shows in production, show1 that should use Autodesk Maya 2018, and show2 that should use | ||
| Maya 2019. The mechanism that stores and retrieves this configuration information is the configuration system. | ||
|
|
||
| This configuration could commonly be stored in a database, and it would be tedious and error-prone to force | ||
| non-technical artists to lookup this information and write Rez requests themselves. | ||
|
|
||
| For this reason, it's common that the more technical folks of the studio would want to build a CLI or GUI "launcher" | ||
| to expose to the less technical artists of the studio that would allow them to select which project they are working | ||
| on, and perhaps which DCC tool they want to use, and the launcher will automatically formulate the Rez request. | ||
|
|
||
| For example, a hypothetical CLI launcher like so: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| usage: studio_launcher.py [-h] [-p PROJECT] dcc | ||
|
|
||
| A simple CLI launcher. | ||
|
|
||
| positional arguments: | ||
| dcc DCC tool to launch | ||
|
|
||
| options: | ||
| -h, --help show this help message and exit | ||
| -p, --project PROJECT The name of the project | ||
|
|
||
| This launcher would know to communicate with the configuration system in order to lookup which version of the DCC | ||
| to use and would also request any other packages that are needed (such as proprietary workflow tools). | ||
|
|
||
| Alternatives to Rez | ||
| =================== | ||
|
|
||
| Package Managers | ||
| ---------------- | ||
|
|
||
| `pip <https://packaging.python.org/en/latest/key_projects/#pip>`_ | ||
|
|
||
| Environment Managers | ||
| -------------------- | ||
| `venv <https://packaging.python.org/en/latest/key_projects/#venv>`_ | ||
|
|
||
| `virtualenv <https://packaging.python.org/en/latest/key_projects/#virtualenv>`_ | ||
|
|
||
| Package and Environment Managers | ||
| -------------------------------- | ||
| `conda <https://packaging.python.org/en/latest/key_projects/#conda>`_ | ||
|
|
||
| Conda was primarily created to solve packaging problems in the Python ecosystem, but is not Python specific. | ||
| Conda creates persistent, on-disk environments while Rez creates in-memory ephemeral environments. Rez doesn't | ||
| have to local install packages to work (but it can with the package caching feature), where Conda does. | ||
|
|
||
| This feature of Rez is very useful is VFX/Animation where "work" is done on render farm machines whose disk space is | ||
| often quite limited. Shared filesystems are common in VFX/Animation, which means they are often configured to be | ||
| accessed very quickly. Due to this, Rez is very fast. | ||
|
|
||
| Conda *can* create environments on shared filesystems, but | ||
| there would be lots of caveats and hidden dragons. | ||
|
|
||
| `spack <https://packaging.python.org/en/latest/key_projects/#spack>`_ | ||
|
|
||
| `Conan <https://docs.conan.io/2/>`_ | ||
|
|
||
| `SPK <https://getspk.io/>`_ | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"provide" seems redundant in this sentence