Skip to content

Commit 1627029

Browse files
committed
DOC-026: Move overview to the index page, above the comments.
1 parent 5554df7 commit 1627029

File tree

2 files changed

+29
-31
lines changed

2 files changed

+29
-31
lines changed

docs/index.rst

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
1-
Welcome to the Virtual Micromagnetics documentation
2-
===================================================
1+
Virtual Micromagnetics Documentation
2+
====================================
3+
4+
Welcome to the :term:`Virtual Micromagnetics` project, where we aim to enable
5+
accessible and reproducible micromagnetics simulation, without compromise.
6+
7+
The :term:`Virtual Micromagnetics` project creates :term:`virtual
8+
environment`\s that run micromagnetic (and in some cases, atomistic)
9+
simulations of magnetic behaviour. These environments produce :term:`system
10+
virtual machine`\s which emulate a configured set of software on your
11+
computer. This means you as a user only need to manage the software to support
12+
the virtual machine, as opposed to the complicated set of dependencies most
13+
simulation packages require. As a result, these virtual environments are far
14+
simpler to maintain, meaning you have more time to solve the mysteries of the
15+
universe instead of:
16+
17+
- wondering why the latest version of a package is incompatible with earlier
18+
simulations.
19+
20+
- wondering how to maintain multiple versions of a package to support old
21+
simulation software.
22+
23+
- persuading your high-performance computing system administrator to support
24+
your long list of software dependencies.
25+
26+
- setting up user accounts and packages for new students to run simulations.
27+
28+
Contents
29+
--------
330

431
.. toctree::
5-
introduction
632
getting-started
733
virtual-machine-software
834
user-information

docs/introduction.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)