Pipeline Managment
This is a heavily modified version of the previous DCC pipe https://github.com/byu-animation/dccpipe.
The BYU_anm_pipeline is designed to run on the Fedora operating system and allow for communication between several content creation softwares. A major modification is that this pipe is built on a USD backbone https://github.com/PixarAnimationStudios/USD rather than a purely Alembic-based structure. This referenced file system allows for adjustments to flow up and down the pipeline instead of the traditional waterfall pipelines.
To install all development packages, execute the following in a bash terminal:
git clone https://github.com/smartins1234/BYU_anm_pipeline.git
cd BYU_anm_pipeline
source setup/install.sh --dev
To activate and test the virtual environment:
source launch/env.sh
python
>>import PySide2
>>import pipe.tools
git clone https://github.com/smartins1234/BYU_anm_pipeline.git
cd BYU_anm_pipeline
source setup/install.sh --clean
Installs all development packages
source config/unix/fedora/install.sh --dev
Cleans the previous installation by deleting .venv folder
source config/unix/fedora/install.sh --clean
Installs missing packages with pip/yum. Note: if you are missing an rpm, you must run this as root. If you are only missing pip packages, you can run this as a normal user.
sudo config/unix/fedora/install.sh --installmissing
- run project initialization script: python create_project.py nameOfProject nicknameOfProject
- Check that application launching icons were created (Maya, Houdini, Substance Painter, Nuke)
- Check that production directory was created with several subdirectories inside
- If 2 and 3 look right, you're good to go!
This project is based off of the previous BYU Animation pipeline. DCC Pipe. That, in turn, succeeeded the previous pipeline repositories BYU Animation Tools and BYU Pipeline Tools. This pipeline was created with a very specific use case, and is not intended to be used outside of the BYU Center for Animation labs. However, the pipeline is designed so that other distros/operating systems can be supported in a future release, given appropriate modifications.
| Requirements | Description |
|---|---|
| Fedora 27/RHEL | The current Linux distro at BYU. (RHEL distros should be supported.) |
| Python 2.7.5 | Most DCCs depend on Python 2.7 for the time being, so by extension, so does DCCPipe |
| pip* | Required for pipenv |
| pipenv* | Virtualenv manager for python dependencies |
| qt-qtbase-devel* | Required for PySide2 |
| libxml2-devel* | Required for PySide2 |
* Will be automatically installed using the --installmissing/-im flag.
| DCC | Version | Module |
|---|---|---|
| Autodesk Maya | 2022 | pipe.tools.maya |
| SideFX Houdini | 18.5 | pipe.tools.hou |
| Foundry Nuke | 13.0 | pipe.tools.nuke |
| Allegorithmic Substance Painter | 2018.3 | pipe.tools.sbs |
Note: All packages will be installed in the project's directory in the .venv folder.
| Pipenv Package | --dev only |
|---|---|
| pyside2* | no |
| shiboken2* | no |
| qt-py | no |
| termgraph | yes |
| loguru | yes |
| pytest | yes |
| sphinx | yes |
* Due to a virtualenv limitation, pyside2 and shiboken2 will be installed to user, and then copied into the project directory. The script that handles this is config/unix/fedora/install_pyside.sh