Getting Started With Atlas

Welcome to your Optilogic Optimization Studio Workspace! For a more in-depth look into the different aspects of the Atlas Modeling Studio, please see Build.

The first thing that you will want to do is familiarize yourself with the different pieces of the modeling studio.

This is a pre-configured environment that has all the tools and technology you need to model and solve optimization problems. It comes with Python 3.7, Pyomo, and our open source Optilogic Solver.

Welcome to Atlas

Opening & Running a Model

File Explorer

To open the File Explorer view, click on the File Explorer icon in the action bar.

File Explorer Icon

The File Explorer view is where all of your files will live, and they can be referenced in any model or code file simply by prefixing any path with “/projects”.

Your File Explorer comes with the functionality that you would expect from any file management system. You can add or remove files and folders, move things around, rename and copy and paste. In addition to this, you can upload files from your local computer, or download files from Atlas to share with colleagues. All of this functionality is accessible through the context menu when you right click anywhere in the File Explorer view.

Left Click Options

Editor

Put on your hardhats because this is where the work is done. Atlas has a feature rich, professional grade editor baked into it so you can focus on writing your model.

Click on any file in the File Explorer and it will automatically open in the editor for you. This works both ways too! If you lose your place in the File Explorer, right-click the tab header of the file you are viewing (or Alt + R) and select “Reveal In Explorer” and you will be brought right to that file.

Reveal in Explorer


But that’s not all! Within the editor you have:

  • Full code analysis running in the background to check for warnings and errors
  • Auto completion that updates to include your code objects as you build your model
  • Rich syntax highlighting to make reading your model easier
  • A file minimap to give you high level contextual information about your code structure
  • A context menu full of navigation, formatting, and basic text controls

The editor available to you in Atlas rivals the best editors out there, and it will continue to be improved in order to make your work more productive.

Expand coding functions right click

Running a Model

Running a model is simple and easy. Just click the Run in Studio button and watch your optimization go.

Running a Model in Atlas

The output will also display any runtime code errors that you may have as well as context information about where they occurred in the model.

More details can be here:

Debug

Sometimes you will want to do a deep dive into the execution of your model. Atlas allows you to debug the code that defines your model to ensure that everything looks and works the way it should.

To debug your model, open the Debug View by clicking on the Debug View icon in the left action pane.

From here you can start, stop, pause, and restart your debug session, as well as step over, into, and out of code statements.

Debug toolbar

You will also have access to a wealth of information about your model from the technical perspective. You can see how many threads you have running, what your call stack looks like if you are paused, variables that exist in the code with their current values, and breakpoints. You will also be able to watch specific code objects or evaluate expressions in the watch section to see how things change over time.

To set a breakpoint, simply move your mouse to the left-most part of the editor and you will see a red dot follow your cursor, line by line.

Setting a breakpoint to debug

Click the line you want a breakpoint on and that dot will stay put. You now have a breakpoint set! You can also just click on a line of code and select a new breakpoint from the Debug menu.

Setting a Breakpoint two ways