osiris
OSIRIS Particle-In-Cell code
File Explorer
Download Latest Version (.zip)- config.cfg
- Dockerfile
- osiris
- osiris_buildserver
- README.md
- Dockerfile.osiris_gcc83
- install_helper.sh
- osiris
- osiris_buildserver
- README.md
- Makefile.in
- osiris_config.overrides.example
- osiris_sys.accelerates.gnu
- osiris_sys.bluewaters
- osiris_sys.cirrus
- osiris_sys.cori
- osiris_sys.docker.gnu
- osiris_sys.docker.gnu.buildserver
- osiris_sys.docker.hpc_compiletools_gcc
- osiris_sys.docker.intel
- osiris_sys.fermi
- osiris_sys.flux
- osiris_sys.hoffman
- osiris_sys.juqueen
- osiris_sys.linux.gnu
- osiris_sys.linux.intel
- osiris_sys.linux.knl
- osiris_sys.linux.mic
- osiris_sys.lle.han
- osiris_sys.ls5
- osiris_sys.macosx-m1.gnu
- osiris_sys.macosx.gnu
- osiris_sys.macosx.ifort
- osiris_sys.macosx.llvm_gnu
- osiris_sys.macosx.pgi
- osiris_sys.marconi
- osiris_sys.marenostrum
- osiris_sys.seawulf
- osiris_sys.template
- osiris_sys.theta
- osiris_sys.threadripper.gnu
- osiris_sys.threadripper.ifort
- osiris_sys.zamb.intel
- os-stdin-custom-solver
- os-stdin-thermal
- 3D_@focus_t=100.png
- 3D_t=0.png
- beam-focus-3D
- beam-focus-rz
- figure1.png
- inject-stdin
- pwfa-example-notebook.ipynb
- os-stdin-rz
- os-stdin-rz-raw-4xresolution
- os-stdin-rz-raw-read
- os-stdin-rz-raw-x1shift
- base-1d
- base-2d
- base-3d
- raw-ref-box.3d
- navigation.yml
- custom.html
- apple-touch-icon.png
- favicon.ico
- icon-192.png
- icon-512.png
- icon.svg
- lwfa.jpg
- pec_B.png
- pec_E.png
- pmc_B.png
- pmc_E.png
- osiris-logo.pdf
- osiris-logo.png
- index.md
- index.md
- Average_Envelope_Grids.md
- Boundary_Conditions.md
- Function_Parser.md
- Grid_Diagnostics.md
- index.md
- Particle_Tracking.md
- Shared_Memory.md
- Antenna.md
- Antenna_Array.md
- Cathode.md
- Collisions.md
- Electric_Current.md
- Electric_Current_Diagnostics.md
- Electro-Magnetic_Field.md
- Electro-Magnetic_Field_Boundaries.md
- Electro-Magnetic_Field_Diagnostics.md
- Electro-Magnetic_Field_Solver.md
- Grid.md
- index.md
- Laser_Pulse.md
- Momentum_Distribution.md
- Neutrals.md
- Neutrals_Diagnostics.md
- Neutrals_with_Moving_Ions.md
- Node_Configuration.md
- Particles.md
- Profile.md
- Restart.md
- Simulation.md
- Smooth.md
- Space.md
- Species.md
- Species_Boundary.md
- Species_Diagnostics.md
- Time.md
- Time_Step.md
- Zpulse.md
- _config.yml
- Gemfile
- index.md
- README.md
- index.md
- Makefile
- os-current-boundary.f03
- os-current-define.f03
- os-current-diagnostics.f03
- Makefile
- os-diagfile-hdf5.f03
- os-diagfile-zdf.f03
- os-diagfile.f03
- os-dutil-hdf5.f90
- os-dutil.f03
- README.md
- Makefile
- os-emf-bnd-define.f03
- os-emf-boundary.f90
- os-emf-lindman.f90
- os-emf-pec.f90
- os-emf-pmc.f90
- os-emf-vpml.f03
- Makefile
- os-emf-diag-define.f03
- os-emf-diagnostics.f03
- os-emf-poynting.f90
- os-emf-psi.f90
- Makefile
- os-emf-solver-define.f03
- os-emf-solver-fei.f03
- os-emf-solver-lehe.f03
- os-emf-solver-ndfx.f03
- os-emf-solver-stencil.f03
- os-emf-solver-yee.f03
- os-emf-solver.f03
- README.md
- Makefile
- os-emf-define.f03
- os-emf-es-solver.f03
- os-emf-gridcenter.f90
- os-emf-gridval.f03
- os-emf-interpolate.f03
- os-emf-ncifilter.f90
- os-emf.f03
- Makefile
- os-fft-new.f03
- os-fft.f03
- Makefile
- os-grid-define.f03
- os-grid-parallel.f90
- os-grid.f90
- README.md
- ioperf.f03
- Makefile
- README.md
- Makefile
- mem-template.h
- memory.f03
- memory.h
- Makefile
- os-emf-meta.f03
- Makefile
- os-particles-charge.f90
- os-particles-define.f03
- os-particles.f03
- Makefile
- os-random-class-grid.f03
- os-random-class.f03
- os-random-cmwc.f03
- os-random-hash.f03
- os-random-kiss.f03
- os-random-mt.f03
- os-random-mwc.f03
- os-random-r250.f03
- os-random.f03
- Makefile
- os-restart-io-binary.f90
- os-restart-io-sion.f90
- os-restart.f90
- fortran.h
- Makefile
- os-spec-current-avx.c
- os-spec-current-avx.h
- os-spec-current-avx2.c
- os-spec-current-avx2.h
- os-spec-current-avx2d.c
- os-spec-current-avx2d.h
- os-spec-current-avx512.c
- os-spec-current-avx512.h
- os-spec-current-avx512d.c
- os-spec-current-avx512d.h
- os-spec-current-avxd.c
- os-spec-current-avxd.h
- os-spec-current-bgq.c
- os-spec-current-bgq.h
- os-spec-current-c.c
- os-spec-current-mic.c
- os-spec-current-mic.h
- os-spec-current-sse.c
- os-spec-current-sse.h
- os-spec-current-ssed.c
- os-spec-current-ssed.h
- os-spec-push-avx.c
- os-spec-push-avx.h
- os-spec-push-avx2.c
- os-spec-push-avx2.h
- os-spec-push-avx2d.c
- os-spec-push-avx2d.h
- os-spec-push-avx512.c
- os-spec-push-avx512.h
- os-spec-push-avx512d.c
- os-spec-push-avx512d.h
- os-spec-push-avxd.c
- os-spec-push-avxd.h
- os-spec-push-bgq.c
- os-spec-push-bgq.h
- os-spec-push-c.c
- os-spec-push-mic.c
- os-spec-push-mic.h
- os-spec-push-sse.c
- os-spec-push-sse.h
- os-spec-push-ssed.c
- os-spec-push-ssed.h
- splines-avx.h
- splines-avx2.h
- splines-avx512.h
- splines-bgq.h
- splines-mic.h
- splines-sse.h
- split-vec.h
- test-avx.c
- test-avxd.c
- test-bgq.c
- test-mic.c
- test-ssed.c
- vector-avx.h
- vector-avx2.h
- vector-avx512.h
- vector-bgq.h
- vector-mic.h
- vector-sse.h
- Makefile
- os-spec-diag-def.f03
- os-spec-diagnostics.f03
- os-spec-phasespace.f03
- os-spec-rawdiag.f03
- README.md
- Makefile
- os-psource-beam.f03
- os-psource-constq.f03
- os-psource-def.f03
- os-psource-file.f03
- os-psource-std.f03
- os-psource.f03
- Makefile
- os-spec-accel.f90
- os-spec-boundary.f03
- os-spec-charge.f90
- os-spec-collisions.f03
- os-spec-comm.f90
- os-spec-current.f03
- os-spec-define.f03
- os-spec-extpush.f03
- os-spec-initfields.f90
- os-spec-loadbalance.f90
- os-spec-memory.f90
- os-spec-piston.f90
- os-spec-push.f03
- os-spec-radcool.f90
- os-spec-sdist.f03
- os-spec-tag.f03
- os-spec-tracks.f03
- os-spec-udist.f03
- os-spec-v3dep.f90
- os-spec-v3int.f90
- os-spec-vpush.f03
- os-species.f03
- Makefile
- os-sys-multi-c.c
- os-sys-multi.f03
- Makefile
- os-cmplx-vdf-math.f03
- os-cmplx-vdf.f03
- os-vdf-average.f03
- os-vdf-comm.f90
- os-vdf-define.f03
- os-vdf-interpolate.f90
- os-vdf-math.f90
- os-vdf-memory.f90
- os-vdf-report.f03
- os-vdf-reportfile.f03
- os-vdf-smooth.f90
- os-vdf.f03
- os-wall-comm.f90
- os-wall-define.f90
- os-wall.f90
- README.md
- Makefile
- zdf-interface.f03
- zdf-par-interface.f03
- zdf-parallel.c
- zdf-parallel.h
- zdf.c
- zdf.h
- zdf.py
- Makefile
- os-zpulse-point.f03
- os-zpulse-speckle.f03
- os-zpulse-std.f03
- os-zpulse-wall.f03
- os-zpulse.f03
- README.md
- config.mk
- config.mk.warnings
- fortran.h
- Makefile
- Makefile.config-info
- Makefile.linesplit
- Makefile.wrapper
- os-antenna.f03
- os-antenna_array.f03
- os-bnd.f03
- os-cathode.f03
- os-config.h
- os-cross.f90
- os-dneutral.f90
- os-dynloadbalance.f03
- os-fparser.f90
- os-input-file.f03
- os-logprof-papi.c
- os-logprof.f90
- os-main.f03
- os-math.f90
- os-nconf.f03
- os-neutral.f03
- os-param.f90
- os-preprocess.fpp
- os-simulation-factory.f03
- os-simulation.f03
- os-space.f90
- os-spline.f90
- os-stringutil.f90
- os-time.f90
- os-timeavg.f90
- os-tstep.f90
- os-units.f90
- os-util.f90
- .gitignore
- configure
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/osiris-code/osiris
Downloads the entire project code from GitHub to your computer.
cd osiris
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โ ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f config/docker/Dockerfile.osiris_gcc83 -t osiris .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 osiris
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd source
This project's files live in a subfolder, so move into it first.
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)
