Set up API access
Before you can run any simulation with the Vanellus solver, you need access to the Vanellus API and an API key. This applies regardless of where you submit simulations from, whether that be a terminal, your own software, or another API client.
Sign in and check your credits
Open the Vanellus dashboard and sign in.
The dashboard shows your current credit balance. Make sure the balance is greater than zero before starting a simulation. If necessary, navigate to the Billing tab to add a payment method and purchase credits.
If the dashboard says that your account is awaiting approval, follow the displayed contact instructions before continuing.
Create an API key
An API key is a secret credential sent with an API request. It allows the Vanellus web servers to identify your account and determine whether the request is authorized.
You can create as many API keys as you need. For example, you can use separate keys for different computers or applications and delete one without affecting the others.
Open API Keys from the dashboard, then:
- Enter a name that describes where you will use the key, such as
command-line. - Select Create API key.
- Copy the key immediately. It begins with
vq_and will not be shown again.
Treat an API key like a password. Do not share it, put it in a simulation JSON file, or commit it to source control. Store it securely, such as in a password manager. Any API request made with a given key is assumed to come from the authorized user, and will be billed as such.
If you lose a key or accidentally expose a key, delete it from the API Keys page and create a replacement. Calls made with a deleted key will stop working immediately.
Use the key from a terminal
If you use Zsh, open $HOME/.zshrc in a text editor and add the following line, replacing the placeholder with your key:
export VANELLUS_API_KEY="paste-your-key-here"
If you use Bash, add the line to $HOME/.bashrc instead. Save the file and open a new terminal, then confirm that the variable is available without printing the key:
test -n "$VANELLUS_API_KEY" && echo "API key is ready"
The terminal should print:
API key is ready
The shell startup file now contains your API key in plain text and loads it in each new terminal. Do not share this file or commit it to source control. Keep the original key in a password manager as your secure backup.
Run your first simulation
Continue with Run your first simulation with Python to download a ready-made electronics-cooling case and see its predicted chip temperature.
See also
- Automate a simulation with Python submits a request constructed in Python.
- Automate a simulation with a shell script submits an existing JSON request.