mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2025-12-30 15:50:55 -06:00
Slight refresh of the Readme
This commit is contained in:
Alexander Bock
@@ -1,3 +1,4 @@
|
||||
# License
|
||||
Copyright (c) 2014-2025
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
@@ -17,5 +18,4 @@ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIO
|
||||
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
||||
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
See the THIRD_PARTY_LICENSES.md for a list an acknowledgement of all external libraries that
|
||||
SGCT uses.
|
||||
See the THIRD_PARTY_LICENSES.md for a list an acknowledgement of all external libraries.
|
||||
|
||||
63
README.md
63
README.md
@@ -1,9 +1,26 @@
|
||||
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
_An open-source interactive data visualization software designed to visualize the entire known universe_
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
[**Docs**](https://docs.openspaceproject.com) · [**Slack**](https://join.slack.com/t/openspacesupport/shared_invite/zt-24uhn3wvo-gCGHgjg2m9tHzKUEb_FyMQ) · [**Website**](http://openspaceproject.com) · [**YouTube**](https://www.youtube.com/@OpenSpaceProj)
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
[](LICENSE.md)
|
||||
<span> • </span>
|
||||
[](https://www.openspaceproject.com/installation)
|
||||
<span> • </span>
|
||||
[](https://join.slack.com/t/openspacesupport/shared_invite/zt-24uhn3wvo-gCGHgjg2m9tHzKUEb_FyMQ)
|
||||
</p>
|
||||
|
||||
|
||||
[OpenSpace](http://openspaceproject.com) is an open source, non-commercial, and freely available interactive data visualization software designed to visualize the entire known universe and portray our ongoing efforts to investigate the cosmos. Bringing the latest techniques from data visualization research to the general public, OpenSpace supports interactive presentation of dynamic data from observations, simulations, and space mission planning and operations. The software works on multiple operating systems (Windows, Linux, MacOS) with an extensible architecture capable of powering both personal computers and also high resolution tiled displays and planetarium domes. In addition, OpenSpace enables simultaneous connections across the globe creating opportunity for shared experiences among audiences worldwide. The target audience of the software reaches from the general public who wishes to explore our universe, enthusiasts interested in hacking the underlying components in OpenSpace to create unique experiences, informal science institutions wishing to create a low-cost, yet powerful exhibition piece, but also scientists desiring to visualize their datasets in a contextualized, powerful software.
|
||||
|
||||
[](LICENSE)
|
||||
[](https://www.openspaceproject.com/installation)
|
||||
|
||||
|
||||
[](https://doi.org/10.1109/TVCG.2019.2934259)
|
||||
[](https://doi.org/10.1109/TVCG.2017.2743958)
|
||||
@@ -14,51 +31,59 @@
|
||||
|
||||
|
||||
|
||||
# Background
|
||||
<h1 align="center">Background</h1>
|
||||
OpenSpace started as a collaboration between Sweden's [Linköping University](https://immvis.github.io) (LiU) and the [American Museum of Natural History](https://www.amnh.org) (AMNH). Development of the software began several years ago through a close collaboration with NASA Goddard's [Community Coordinated Modeling Center](https://ccmc.gsfc.nasa.gov) (CCMC) to model space weather forecasting and continued with visualizations of NASA's New Horizons mission to Pluto and ESA's Rosetta mission to 67P/Churyumov-Gerasimenko. This promising set of preliminary work provided a foundation for continued funding from NASA, the Swedish eScience Research Centre, and the Knut and Alice Wallenberg foundation, which has extended the collaboration to include the University of Utah's [Scientific Computing and Imaging](https://www.sci.utah.edu) (SCI) Institute, [New York University](https://www.nyu.edu)'s Tandon School of Engineering, multiple informal science institutions across the world, and multiple, international vendors.
|
||||
|
||||
|
||||
|
||||
|
||||
# Features
|
||||
<h1 align="center">Features</h1>
|
||||
Some of the high-level features supported in OpenSpace are:
|
||||
|
||||
- AMNH's Digital Universe catalog of extrasolar datasets (stars, galaxies, quasars, ...)
|
||||
- High-resolution planetary images for major objects in the solar system (Earth, Moon, Mars, Venus, ...)
|
||||
- Animated 3D models representing space missions (ISS, New Horizons, JWST, ...)
|
||||
- Support for custom profiles with arbitrary user-defined content
|
||||
- Ability to drive any type of display environment (flat screen, multi-projector, planetariums, ...)
|
||||
- Lua and JavaScript interface into the engine allowing highly customized controls
|
||||
- Lua, JavaScript, and Python interfaces into the engine allowing highly customized controls
|
||||
- Native support to export an interactive sessions as individual frames for video export
|
||||
- much much more (see our [Changelog](http://wiki.openspaceproject.com/docs/general/releases))
|
||||
- much much more (see our [Changelog](https://github.com/OpenSpace/OpenSpace/releases/))
|
||||
|
||||
OpenSpace requires at least support for [OpenGL](https://www.opengl.org/) version 3.3, some custom components require at least version 4.2.
|
||||
|
||||
|
||||
|
||||
|
||||
# Getting Started
|
||||
This repository contains the source code and example profiles for OpenSpace, but does not contain any data. To build and install the application, please check out the [Documentation](https://docs.openspaceproject.com). Here, you will find the build instructions for all operating systems. Please note that the Apple Silicon series of chips do not support OpenGL natively and Metal 2 does not support `double` precision accuracy (see [here](https://developer.apple.com/metal/Metal-Shading-Language-Specification.pdf) Section 2.1), therefore only the Intel processors for MacOS are supported and maintained.
|
||||
<h1 align="center">Getting Started</h1>
|
||||
This repository contains the source code and example profiles for OpenSpace, but does not contain any data. To build and install the application, please check out the [Documentation](https://docs.openspaceproject.com). Here, you will find the build instructions for all operating systems. Please note that the Apple Silicon series of chips do not support OpenGL natively and Metal 2 does not support `double` precision accuracy (see the [specification](https://developer.apple.com/metal/Metal-Shading-Language-Specification.pdf) Section 2.1), therefore only the Intel processors for MacOS are supported and maintained.
|
||||
|
||||
Requirements for compiling are:
|
||||
|
||||
- CMake version 3.25 or above
|
||||
- C++ compiler supporting C++20/C++23 (Visual Studio 2022 17.11, GCC13, Clang17, AppleClang 15.0.0)
|
||||
- [Qt](http://www.qt.io/download)
|
||||
|
||||
|
||||
## :bulb: Asking Questions
|
||||
<h2 align="center">:bulb: Asking Questions :bulb:</h2>
|
||||
Feel free to create issues for missing features, bug reports, or compile problems or contact us via [email](mailto:support@openspaceproject.com?subject=OpenSpace:). Regarding any issues, you are very welcome on our [Slack support channel](https://openspacesupport.slack.com) to which you can freely [sign-up](https://join.slack.com/t/openspacesupport/shared_invite/zt-24uhn3wvo-gCGHgjg2m9tHzKUEb_FyMQ).
|
||||
|
||||
## :heart: Contributing
|
||||
Any contributions to the software are very welcome and can take a multitude of forms, from reporting a bug, fixing bugs, creating new content, writing new features, and even creating and sharing images and videos you have made with the software. Please feel free to share anything you want in the #sharespace channel on the Slack.
|
||||
<h2 align="center">:heart: Contributing :heart:</h2>
|
||||
Any contributions to the software are very welcome and can take a multitude of forms, from reporting a bug, fixing bugs, creating new content, writing new features, and even creating and sharing images and videos you have made with the software. Please feel free to share anything you want in the #showcase channel on the Slack.
|
||||
|
||||
|
||||
|
||||
|
||||
# License
|
||||
The contents of this repository provided under an [MIT license](https://github.com/OpenSpace/OpenSpace/blob/master/LICENSE.md).
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
# Support
|
||||
OpenSpace is supported by the following institutions:
|
||||
<h1 align="center">License</h1>
|
||||
OpenSpace is under an permissive [MIT license](https://github.com/OpenSpace/OpenSpace/blob/master/LICENSE.md). The license files contains for more detail, but the short version is that you can use OpenSpace for commercial or non-commercial purposes as long as you give credit.
|
||||
|
||||
|
||||
|
||||
<h1 align="center"> Support</h1>
|
||||
OpenSpace is grateful for the support from the following institutions:
|
||||
|
||||
<p align="center">
|
||||
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user