Skip to content

Commit

Permalink
Merge pull request #710 from braunms/master
Browse files Browse the repository at this point in the history
Readme and Manual Update
  • Loading branch information
tobiasrau authored Feb 18, 2021
2 parents 8a2995f + 026fc70 commit dfdc59f
Show file tree
Hide file tree
Showing 21 changed files with 730 additions and 644 deletions.
56 changes: 10 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,64 +4,28 @@
[![Build status](https://ci.appveyor.com/api/projects/status/jrtnh313libyy3vj/branch/master?svg=true)](https://ci.appveyor.com/project/megamolservice/megamol/branch/master)


MegaMol is a visualization middleware used to visualize point-based molecular data sets. This software is developed within the Collaborative Research Center 716, subproject ​D.3 at the ​[Visualization Research Center (VISUS)](https://www.visus.uni-stuttgart.de/en) of the University of Stuttgart and at the ​Computer Graphics and Visualization Group of the TU Dresden.
MegaMol is a visualization middleware used to visualize point-based molecular data sets. This software is developed within the Collaborative Research Center 716, subproject ​D.3 at the ​[Visualization Research Center (VISUS)](https://www.visus.uni-stuttgart.de/en) of the University of Stuttgart and at the ​Computer Graphics and Visualization Group of the TU Dresden.

MegaMol succeeds MolCloud, which has been developed at the University of Stuttgart in order to visualize point-based data sets. MegaMol is written in C++, and uses an OpenGL as Rendering-API and GLSL-Shader. It supports the operating systems Microsoft Windows and Linux, each in 32-bit and 64-bit versions. In large parts, MegaMol is based on VISlib, a C++-class library for scientific visualization, which has also been developed at the University of Stuttgart.
MegaMol succeeds MolCloud, which has been developed at the University of Stuttgart in order to visualize point-based data sets. MegaMol is written in C++, and uses an OpenGL as Rendering-API and GLSL-Shader. It supports the operating systems Microsoft Windows and Linux, each in 64-bit version. In large parts, MegaMol is based on VISlib, a C++-class library for scientific visualization, which has also been developed at the University of Stuttgart.


## Changelog
​See [changelog](https://github.com/UniStuttgart-VISUS/megamol/wiki/Changelog) for newly available features in the current version of MegaMol.


## Building MegaMol
### Linux
1. Clone the MegaMol repository
2. Create a build folder
3. Invoke `cmake` inside the build folder
4. Execute `make` to build MegaMol
5. Run `make install` to create your MegaMol installation
6. Test Megamol with

$ ./megamol.sh -p ../examples/testspheres.lua

## Manual

### Windows
1. Clone the MegaMol repository
2. Use the cmake GUI to configure MegaMol
1. The configuration creates a `sln` file inside the build folder
3. Open the `sln` file with *Visual Studio*
4. Use the `ALL_BUILD` target to build MegaMol
5. Use the `INSTALL` target to create your MegaMol installation
6. Test Megamol with
See the [manual](docs/manual.md) for detailed instructions on how to build and use MegaMol.

> mmconsole.exe -p ..\examples\testspheres.lua


## MegaMol Configurator
MegaMol offers a configurator GUI (C#) that runs with .Net Framework 4.
It runs also on Linux with Mono 3.2.8 (except for the analysis function and indirect-start functions).

## Changelog

## How to use MegaMol
For a detailed description have a look at the [manual](docs/manual.md).
​See the [changelog](https://github.com/UniStuttgart-VISUS/megamol/wiki/Changelog) for newly available features in the current version of MegaMol.

## License

## Using the plugin template
1. Copy the template folder
2. Rename the copied folder to the intended plugin name
3. Execute the instawiz.pl script inside the new folder
1. The script detects the plugin name
2. Autogenerate the GUID
4. Remove instawiz.pl
5. Add libraries/dependencies to `CMakeLists.txt` (optional)
6. Implement the content of your plugin
7. Write a `Readme.md` for your plugin (mandatory)
8. Add the folder to your local git
See the [license](LICENSE) file.


## Citing MegaMol
Please use one of the following methods to reference the MegaMol project.

Please use one of the following methods to reference the MegaMol project.

**MegaMol – A Comprehensive Prototyping Framework for Visualizations**
P. Gralka, M. Becher, M. Braun, F. Frieß, C. Müller, T. Rau, K. Schatz, C. Schulz, M. Krone, G. Reina, T. Ertl
Expand Down Expand Up @@ -140,7 +104,7 @@ In Proceedings of IEEE Pacific Visualization Symposium 2009: 65 - 72, 2009
}

#
**MegaMol project website**
**MegaMol project website**
[https://megamol.org](https://megamol.org)

@misc{megamol,
Expand Down
5 changes: 2 additions & 3 deletions console/extra/megamolconfig.lua.in
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
-- Standard MegaMol Configuration File --

print("I am the Standard MegaMol configuration!")
print("Standard MegaMol Configuration:")

basePath = "${CMAKE_INSTALL_PREFIX}/"

mmSetLogLevel("*") -- LogLevel: None=0,Error=1,Warn=100,INFO=200,ALL=*
mmSetEchoLevel("*")
-- mmSetLogFile("")
mmSetAppDir(basePath .. "${MMPLG_DIR}")
mmAddShaderDir(basePath .. "share/shaders")
mmAddResourceDir(basePath .. "share/shaders")
Expand All @@ -21,4 +21,3 @@ mmSetConfigValue("fullscreen", "off")
mmSetConfigValue("vsync", "off")
mmSetConfigValue("useKHRdebug", "off")
mmSetConfigValue("arcball", "off")

Loading

0 comments on commit dfdc59f

Please sign in to comment.