-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add config docs about environment variables #39
base: master
Are you sure you want to change the base?
Conversation
|
||
- It might save you space as you don’t have to store data in multiple places. | ||
|
||
- `OPENSPACE_GLOBEBROWSING` If this environment variable is set, the OpenSpaceData folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: |
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.
- `OPENSPACE_GLOBEBROWSING` If this environment variable is set, the OpenSpaceData folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: | |
- `OPENSPACE_GLOBEBROWSING`: If this environment variable is set, the `OpenSpaceData` folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: |
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.
- `OPENSPACE_GLOBEBROWSING` If this environment variable is set, the OpenSpaceData folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: | |
- `OPENSPACE_GLOBEBROWSING`: If this environment variable is set, the `OpenSpaceData` folder (which normally is placed one level above the OpenSpace folder) can be placed anywhere on your computer. This folder stores all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: |
A bit unsure about the formulation "This folder stores all the map data form planets". Not obvious to me what that means. And it's not all the data, right?
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.
Any suggestions how to make this clearer?
|
||
OpenSpace uses a configuration file which is called `openspace.cfg`. This file is located in the OpenSpace folder. This file determines: | ||
|
||
- The SGCT configuration (the type of projection and number of windows) |
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.
How about removing the empty line after each point? makes no difference in the output
Also, Mr @alexanderbock usually wants the list indented one step, so I guess that should be done for this file as well (?)
|
||
- Log and script log outputs | ||
|
||
...and a number of other configurations. For complete documentation with regards to the config file, please refer to [this page](#core_configuration). |
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.
This link does not work.
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.
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.
Interesting. Did not work in my local build
Feel free to ignore then :)
|
||
- It might save you space as you don’t have to store data in multiple places. | ||
|
||
- `OPENSPACE_GLOBEBROWSING` If this environment variable is set, the OpenSpaceData folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: |
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.
- `OPENSPACE_GLOBEBROWSING` If this environment variable is set, the OpenSpaceData folder which normally is placed one level above the OpenSpace folder, can be placed anywhere on your computer. This folder stored all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: | |
- `OPENSPACE_GLOBEBROWSING`: If this environment variable is set, the `OpenSpaceData` folder (which normally is placed one level above the OpenSpace folder) can be placed anywhere on your computer. This folder stores all the map data from planets. This is very handy if you are using multiple versions of OpenSpace, for the following reasons: |
A bit unsure about the formulation "This folder stores all the map data form planets". Not obvious to me what that means. And it's not all the data, right?
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Alexander Bock <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Co-authored-by: Emma Broman <[email protected]>
Got tired of having to look for the environment variables in the source code, so I decided to write up a quick docs page for it.