Skip to content
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 documentation on building and running the simple simulation examples. #17296

Open
brugger1 opened this issue Feb 2, 2022 · 6 comments
Open
Labels
docs update to the documentation impact high Productivity significantly degraded (non-mitigable bug) or improved (enhancement) likelihood medium Neither low nor high likelihood low-hanging fruit A cognizant developer has a shot at resolving in <1/2 day of work reviewed Issue has been reviewed and labeled by a developer

Comments

@brugger1
Copy link
Collaborator

brugger1 commented Feb 2, 2022

We should add documentation to the getting data into visit section of the manual on how to build and run the examples in the simulation example directory. We don't have any libsim documentation in the user manual, but this would be a good start to supplement what is in the GettingDataIntoVisIt2.0.0.pdf.

Here is how to compile one of the examples against an installation of VisIt.

gcc -I. -I/usr/gapps/visit/3.1.4/linux-x86_64/libsim/V2/include -L/usr/gapps/visit/3.1.4/linux-x86_64/libsim/V2/lib -Wl,-rpath=/usr/gapps/visit/3.1.4/linux-x86_64/libsim/V2/lib -lsimV2dyn -ldl -lm sim4.c -o sim4

Here are the environment variables to set for running the simulation.

setenv LD_LIBRARY_PATH /usr/gapps/visit/3.1.4/linux-x86_64/lib/mesagl:/usr/gapps/visit/3.1.4/linux-x86_64/lib
setenv VISITPLUGINDIR /usr/gapps/visit/3.1.4/linux-x86_64/plugins

Note that sim4.c doesn't do much and sim1.c through sim12.c incrementally add functionality in terms of additional data to be passed to VisIt. Even sim12.c doesn't pass valid mesh and variable data though.

@brugger1 brugger1 added likelihood medium Neither low nor high likelihood impact medium Productivity partially degraded (not easily mitigated bug) or improved (enhancement) docs update to the documentation labels Feb 2, 2022
@brugger1
Copy link
Collaborator Author

brugger1 commented Feb 2, 2022

The GettingDataIntoVisIt2.0.0.pdf is located at:

https://wci.llnl.gov/sites/wci/files/2020-08/GettingDataIntoVisIt2.0.0.pdf

@brugger1
Copy link
Collaborator Author

brugger1 commented Feb 2, 2022

There is some information on building an example on a Mac at:

http://www.visitusers.org/index.php?title=VisIt-tutorial-in-situ

@brugger1
Copy link
Collaborator Author

brugger1 commented Feb 2, 2022

The examples are located in src/tools/data/DataManualExamples/Simulations.

@markcmiller86
Copy link
Member

Be aware of some of the issues mentioned in #16989 also.

@markcmiller86
Copy link
Member

I think there are other aspects of this especially for macOS discussed in #16986 too.

@markcmiller86
Copy link
Member

Sorry to dribble out but a number of imported email discussions mention the mandelbrot example. I dunno if they also shed light on any missing documentation too but they might.

@brugger1 brugger1 self-assigned this Feb 8, 2022
@brugger1 brugger1 added impact high Productivity significantly degraded (non-mitigable bug) or improved (enhancement) low-hanging fruit A cognizant developer has a shot at resolving in <1/2 day of work reviewed Issue has been reviewed and labeled by a developer and removed impact medium Productivity partially degraded (not easily mitigated bug) or improved (enhancement) labels Feb 8, 2022
@brugger1 brugger1 removed their assignment May 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs update to the documentation impact high Productivity significantly degraded (non-mitigable bug) or improved (enhancement) likelihood medium Neither low nor high likelihood low-hanging fruit A cognizant developer has a shot at resolving in <1/2 day of work reviewed Issue has been reviewed and labeled by a developer
Projects
None yet
Development

No branches or pull requests

2 participants