Recent changes to Home

Home modified by Matthew Jones

Matthew Jones — Thu, 13 Jun 2019 02:14:06 -0000

--- v19
+++ v20
@@ -1,8 +1,8 @@
 # OpenMPS Wiki
 ## Table of Contents
-1. [OpenMPS on Google Colab]
-2. [OpenMPS with Docker]
-3. [OpenMPS from Source]
+1. [OpenMPS on Google Colab] ... valid for any operating system
+2. [OpenMPS with Docker] ... valid for any operating system
+3. [OpenMPS from Source] ... valid only for Linux and Unix operating systems
 4. [Useful Links]
 5. [Citing OpenMPS]

Home modified by Matthew Jones

Matthew Jones — Mon, 27 May 2019 14:27:00 -0000

--- v18
+++ v19
@@ -12,7 +12,7 @@

 1. Google Colab: a Google-hosted runtime that enables you to use OpenMPS from the comfort of your web browser.  No installation or new software is required on your local machine. This is ideal if you'd like to get a feel for what OpenMPS can do.
 2. OpenMPS with Docker: OpenMPS packaged in a containerized runtime, for you to use on your local machine. Recommended *only* if you're familiar with Docker.
-3. OpenMPS built from source: ideal for custom deployments, users interested in running jobs locally in their favorite IDE.
+3. OpenMPS built from source: ideal for custom deployments, users interested in running jobs locally with their favorite IDE.

 ## Where are the Docs?

Home modified by Matthew Jones

Matthew Jones — Mon, 27 May 2019 05:02:03 -0000

--- v17
+++ v18
@@ -5,3 +5,15 @@
 3. [OpenMPS from Source]
 4. [Useful Links]
 5. [Citing OpenMPS]
+
+## Who is the Wiki for?
+
+The OpenMPS Wiki is meant to be a comprehensive quick-start guide. Its purpose is to streamline the process of acquiring and using OpenMPS in a meaningful way. To that end, we maintain three distinct deployment paths.
+
+1. Google Colab: a Google-hosted runtime that enables you to use OpenMPS from the comfort of your web browser.  No installation or new software is required on your local machine. This is ideal if you'd like to get a feel for what OpenMPS can do.
+2. OpenMPS with Docker: OpenMPS packaged in a containerized runtime, for you to use on your local machine. Recommended *only* if you're familiar with Docker.
+3. OpenMPS built from source: ideal for custom deployments, users interested in running jobs locally in their favorite IDE.
+
+## Where are the Docs?
+
+The OpenMPS documentation is hosted on SourceForge. You may access it on the web from [this location](https://openmps.sourceforge.io "OpenMPS Documentation"). Alternatively, OpenMPS Docs are packaged with each release. They are available for [download here](https://sourceforge.net/projects/openmps/files/OpenSourceMPS_v3.1/OpenMPSDocs.zip/download "OpenMPS Documentation Download").

Home modified by Matthew Jones

Matthew Jones — Sat, 25 May 2019 18:32:39 -0000

--- v16
+++ v17
@@ -5,5 +5,3 @@
 3. [OpenMPS from Source]
 4. [Useful Links]
 5. [Citing OpenMPS]
-
-[[members limit=20]]

Home modified by Matthew Jones

Matthew Jones — Sat, 25 May 2019 05:07:25 -0000

--- v15
+++ v16
@@ -1,90 +1,9 @@
-#OpenMPS Quick Start
-## Building from source using `apt` package management
-1)  Install core library dependencies using your OS package manager:
-```bash
-$ sudo apt install \
-        liblapack-dev \
-        libarpack2-dev \
-        libopenmpi-dev
-```
-2)  Install python dependencies using your python package manager
-```bash
-$ pip3 install \
-        sphinx sphinxcontrib-bibtex \
-        jupyterlab \
-        numpy \
-        scipy \
-        matplotlib \
-        nose
-```
-3)  Build and install OpenMPS to your desired path. Note that the `--prefix` value must be accessible to the python scripts you're using.
-```bash
-$ cd /path/to/openmps
-$ python setup.py install
-$ python BuildOSMPS.py --prefix=/path/to/your/preferred/bin \
-                       --option=FC:/path/to/your/preferred/fotran/compiler \
-                       --option=INCFLAGS:-I/path/to/your/includes.h \
-                       --option=LIBFLAGS:-L/path/to/your/library.so
-```
-
-## Building from source using Anaconda `conda` package management
-
-1) From the root directory of the OpenMPS source code, create a virtual environment from all the dependencies `.yml` file.
-```bash
-conda env create --name openmps --file conda/environments/openmps.yml
-```
-
-2) Upon completion, from the root directory of the OpenMPS source code,
-```bash
-source activate openmps && \
-python setup.py install && \
-python BuildOSMPS.py --prefix=$CONDA_PREFIX/bin \
-                       --option=FC:x86_64-conda_cos6-linux-gnu-gfortran \
-                       --option=INCFLAGS:-I$CONDA_PREFIX/include \
-                       --option=LIBFLAGS:-L$CONDA_PREFIX/lib
-```
-
-## Building from source using Docker
-
-1) From the root directory of the OpenMPS source code, run the following command
-```bash
-bash Docker-Utils/build-openmps.sh
-```
-
-2) To run the Docker container, 
-```bash
-bash Docker-Utils/run-openmps.sh
-```
-
-3) Once inside the container, run
-```bash
-source activate openmps
-```
-
-## **EXPERIMENTAL** Building from source using Windows
-
-The `conda/environments/openmps.yml` file is designed to build an environment for Linux-based operating systems. To make it Windows-compatible, remove the reference to ` - gfortran_linux-64`, and update the build command so that it points to the Fortran compiler on your system
-```bash
-source activate openmps && \
-python setup.py install && \
-python BuildOSMPS.py --prefix=$CONDA_PREFIX/bin \
-                       --option=FC:/path/to/your/fortran/compiler \
-                       --option=INCFLAGS:-I$CONDA_PREFIX/include \
-                       --option=LIBFLAGS:-L$CONDA_PREFIX/lib
-```
-
-## Some useful links and information
-
-Please join the [Discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.
-
-Open [trouble tickets](http://sourceforge.net/p/openmps/tickets/) or Request Enhancements.
-
-Download the latest [source files](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](http://sourceforge.net/p/openmps/code/HEAD/tree/).
-
-[Overviews] for using the software.
-
-[References] to cite when using OpenMPS, and some papers to review for your learning.
+# OpenMPS Wiki
+## Table of Contents
+1. [OpenMPS on Google Colab]
+2. [OpenMPS with Docker]
+3. [OpenMPS from Source]
+4. [Useful Links]
+5. [Citing OpenMPS]

 [[members limit=20]]
-[[download_button]]
-

Quick Start modified by Matthew Jones

Matthew Jones — Tue, 21 May 2019 18:22:18 -0000

--- v14
+++ v15
@@ -61,7 +61,7 @@
 source activate openmps
 ```

-## [EXPERIMENTAL] Building from source using Windows
+## **EXPERIMENTAL** Building from source using Windows

 The `conda/environments/openmps.yml` file is designed to build an environment for Linux-based operating systems. To make it Windows-compatible, remove the reference to ` - gfortran_linux-64`, and update the build command so that it points to the Fortran compiler on your system
 ```bash

Quick Start modified by Matthew Jones

Matthew Jones — Tue, 21 May 2019 18:21:38 -0000

--- v13
+++ v14
@@ -1,15 +1,13 @@
-**OpenMPS Quick Start **
------
+#OpenMPS Quick Start
+## Building from source using `apt` package management
 1)  Install core library dependencies using your OS package manager:
 ```bash
 $ sudo apt install \
         liblapack-dev \
         libarpack2-dev \
-        libopenmpi-dev \
-        dvipng texlive \
-        texlive-latex-extra
+        libopenmpi-dev
 ```
-2)  Install python dependencies using your python package manager:
+2)  Install python dependencies using your python package manager
 ```bash
 $ pip3 install \
         sphinx sphinxcontrib-bibtex \
@@ -23,23 +21,70 @@
 ```bash
 $ cd /path/to/openmps
 $ python setup.py install
-$ python BuildOSMPS.py --prefix=/path/to/bin
-
-```
-4)  Run any of the examples. Note that `example.py` is meant to be any of the examples.
-```bash
-$ cd /path/to/openmps/examples
-$ python example.py --PostProcess=False
+$ python BuildOSMPS.py --prefix=/path/to/your/preferred/bin \
+                       --option=FC:/path/to/your/preferred/fotran/compiler \
+                       --option=INCFLAGS:-I/path/to/your/includes.h \
+                       --option=LIBFLAGS:-L/path/to/your/library.so
 ```

+## Building from source using Anaconda `conda` package management

+1) From the root directory of the OpenMPS source code, create a virtual environment from all the dependencies `.yml` file.
+```bash
+conda env create --name openmps --file conda/environments/openmps.yml
+```

+2) Upon completion, from the root directory of the OpenMPS source code,
+```bash
+source activate openmps && \
+python setup.py install && \
+python BuildOSMPS.py --prefix=$CONDA_PREFIX/bin \
+                       --option=FC:x86_64-conda_cos6-linux-gnu-gfortran \
+                       --option=INCFLAGS:-I$CONDA_PREFIX/include \
+                       --option=LIBFLAGS:-L$CONDA_PREFIX/lib
+```

-Please join the [discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.
+## Building from source using Docker

-Open [tickets](http://sourceforge.net/p/openmps/tickets/) to get help, or request enhancements.
+1) From the root directory of the OpenMPS source code, run the following command
+```bash
+bash Docker-Utils/build-openmps.sh
+```

-Download the latest [release](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](https://sourceforge.net/p/openmps/v3code/ci/master/tree/).
+2) To run the Docker container, 
+```bash
+bash Docker-Utils/run-openmps.sh
+```

-[References] to cite when using OpenMPS.
+3) Once inside the container, run
+```bash
+source activate openmps
+```

+## [EXPERIMENTAL] Building from source using Windows
+
+The `conda/environments/openmps.yml` file is designed to build an environment for Linux-based operating systems. To make it Windows-compatible, remove the reference to ` - gfortran_linux-64`, and update the build command so that it points to the Fortran compiler on your system
+```bash
+source activate openmps && \
+python setup.py install && \
+python BuildOSMPS.py --prefix=$CONDA_PREFIX/bin \
+                       --option=FC:/path/to/your/fortran/compiler \
+                       --option=INCFLAGS:-I$CONDA_PREFIX/include \
+                       --option=LIBFLAGS:-L$CONDA_PREFIX/lib
+```
+
+## Some useful links and information
+
+Please join the [Discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.
+
+Open [trouble tickets](http://sourceforge.net/p/openmps/tickets/) or Request Enhancements.
+
+Download the latest [source files](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](http://sourceforge.net/p/openmps/code/HEAD/tree/).
+
+[Overviews] for using the software.
+
+[References] to cite when using OpenMPS, and some papers to review for your learning.
+
+[[members limit=20]]
+[[download_button]]
+

Quick Start modified by Matthew Jones

Matthew Jones — Mon, 03 Dec 2018 04:33:02 -0000

--- v12
+++ v13
@@ -41,5 +41,5 @@

 Download the latest [release](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](https://sourceforge.net/p/openmps/v3code/ci/master/tree/).

-[References] to cite when using OpenMPS, and some papers to review for your learning.
+[References] to cite when using OpenMPS.

Quick Start modified by Matthew Jones

Matthew Jones — Mon, 03 Dec 2018 04:31:50 -0000

--- v11
+++ v12
@@ -37,7 +37,7 @@

 Please join the [discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.

-Open [tickets](http://sourceforge.net/p/openmps/tickets/) to get help or Request Enhancements.
+Open [tickets](http://sourceforge.net/p/openmps/tickets/) to get help, or request enhancements.

 Download the latest [release](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](https://sourceforge.net/p/openmps/v3code/ci/master/tree/).

Quick Start modified by Matthew Jones

Matthew Jones — Mon, 03 Dec 2018 04:30:49 -0000

--- v10
+++ v11
@@ -35,13 +35,11 @@

-Please join the [Discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.
+Please join the [discussion](http://sourceforge.net/p/openmps/discussion/) to make OpenMPS better.

-Open [Tickets](http://sourceforge.net/p/openmps/tickets/) to get help or Request Enhancements.
+Open [tickets](http://sourceforge.net/p/openmps/tickets/) to get help or Request Enhancements.

-Download the latest [source](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](http://sourceforge.net/p/openmps/code/HEAD/tree/).
-
-[Overview] for using the software.
+Download the latest [release](http://sourceforge.net/projects/openmps/files/), or browse the [latest code](https://sourceforge.net/p/openmps/v3code/ci/master/tree/).

 [References] to cite when using OpenMPS, and some papers to review for your learning.