dropbox7

How to

Here you'll find short answers to "How do I..?" types of questions. These how-to guides don't cover topics in depth – you'll find that material in the Using Avalon and the Reference. However, these guides will help you quickly accomplish common tasks.




Install

The Avalon pipeline operates either as a server or client. If you've just discovered Avalon and would like to take it for a spin, keep reading until you get to the Server section. Remote artists should read till the Client section, and finally Server is for permanently setting up Avalon in your studio.

Reading Code

You have two options for reading code in this document, one for Windows (cmd) and one for Unix system, including MacOS (bash).

1
These lines are for cmd.exe, typically used in Windows
1
These lines are for bash, typically used in MacOS and Linux




Prerequisites

In order to use Avalon, here's what you need.

Ensure you have PyQt5 installed.

1
pip install PyQt5==5.7.1

Avalon may run with newer version of PyQt5, but if you encounter any issues, please revert to this exact version.

Test installations

Make sure that you are able to successfully type these commands before continuing.

1
2
3
4
5
6
7
8
python --version
rem Python 3.6.1
python -c "from PyQt5.QtCore import PYQT_VERSION_STR as version;print(version)"
rem 5.9
git --version
rem git version 2.8.3.windows.1
mongo --eval "db.version()" --quiet
rem 3.6.4

1
2
3
4
5
6
7
8
python --version
# Python 3.6.1
python -c "from PyQt5.QtCore import PYQT_VERSION_STR as version;print(version)"
# 5.9
git --version
# git version 2.8.3.linux.1
mongo --eval "db.version()" --quiet
# 3.4.4

Download

At this point we are ready to download Avalon, distributed as a single directory with dependencies included.

1
git clone https://github.com/getavalon/setup avalon-setup --recursive
1
git clone https://github.com/getavalon/setup avalon-setup --recursive

Command-line Interface

Avalon offers a command-line interface through which every interaction takes place.

1
set PATH=%cd%\avalon-setup;%PATH%
1
export PATH=$(pwd)/avalon-setup:$PATH

You can test the success of this operation by calling --help.

1
avalon --help

In order to make this command available permanently, you can add it to your system environment.

1
setx PATH "%cd%\avalon-setup;%PATH%"
1
echo PATH=$(pwd)/avalon-setup:$PATH >> ~/.bashrc

Trouble with environment variables?

Avalon uses environment variables a lot. A thorough understanding of them is an important part of maintaining an Avalon pipeline.

See Environment Variables for learning resources.




Demo

If you have just discovered Avalon and would like to take it for a spin, this section is for you.

Prerequisites

Upload Example Project

Avalon ships with at least one example project. In order to make use of it, we'll upload it into your database.

Your Database

If you installed MongoDB locally then the default address is mongodb://localhost:27017

1
avalon --import batman

That's it. Now we're ready to launch Maya through Avalon.

1
avalon

In this project, you'll find a number of assets, including a character - Bruce - and an animated shot - shot1.

Go ahead and open up Maya and load a few assets!




Server

If you are setting up Avalon in your studio, this section is for you.

1
todo



Client

Artists connecting to Avalon from a remote location typically do so given the specific configuration of Avalon into a particular pipeline.

Avalon ships with a default configuration for your reference.



Update

To update avalon-setup, type this.

1
2
3
4
$ cd avalon-setup
$ git pull
$ git submodule init
$ git submodule update --recursive

It is safe to run these as many times as you'd like.