Skip to content

Commit fd3382d

Browse files
williamfgcwilliamfgc
committed
Updating documentation files
1 parent 7943ef3 commit fd3382d

File tree

6 files changed

+108
-3109
lines changed

6 files changed

+108
-3109
lines changed

‎Contributing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributor's Guide
22

3-
This guide will walk you through how to submit changes to ADIOS and interact
4-
with the project as a developer.
3+
This guide will walk you through how to submit changes to ADIOS 2.0 and interact
4+
with the project as a developer. Information found on ADIOS 2.0 wiki: https://github.com/ornladios/ADIOS2/wiki under the Contributing to ADIOS section.
55

66
Table of Contents
77
=================

‎ReadMe.md

+88-69
Original file line numberDiff line numberDiff line change
@@ -17,77 +17,96 @@ Copyright.txt for more details.
1717

1818
## Getting Started
1919

20-
ADIOS 2.0 uses CMake for it's build environment. CMake expects projects to use "out-of-source" builds, which means keeping a separate build and source directory (different from autotools, which usually uses an in-source build). To build ADIOS:
20+
ADIOS 2.0 uses CMake for it's build environment. CMake expects projects to use "out-of-source" builds, which means keeping a separate build and source directory (different from autotools, which usually uses an in-source build). To build ADIOS:
21+
2122
1. Clone the repository:
22-
```
23-
$ mkdir adios
24-
$ cd adios
25-
$ git clone https://github.com/ornladios/adios2.git source
26-
```
23+
24+
```
25+
$ mkdir ADIOS2
26+
$ cd ADIOS2
27+
$ git clone https://github.com/ornladios/adios2.git source
28+
```
29+
2730
2. Create a separate build directory:
28-
```
29-
$ mkdir build
30-
```
31-
3. Configure the project with CMake. The following options can be specified as `ON` or `OFF` with cmake's `-DVAR=VALUE` syntax:
32-
* `ADIOS_BUILD_SHARED_LIBS` - Build shared libraries (`OFF` for static)
33-
* `ADIOS_BUILD_EXAMPLES ` - Build examples
34-
* `ADIOS_BUILD_TESTING ` - Build test code
35-
* `ADIOS_USE_MPI ` - Enable MPI
36-
* `ADIOS_USE_BZip2 ` - Enable BZip2 compression
37-
* `ADIOS_USE_ADIOS1 ` - Enable the ADIOS 1.x engine
38-
* `ADIOS_USE_DataMan ` - Enable the DataMan engine
39-
```
40-
$ cd build
41-
$ cmake -DADIOS_USE_MPI=OFF ../source
42-
-- The C compiler identification is GNU 6.3.1
43-
-- The CXX compiler identification is GNU 6.3.1
44-
-- Check for working C compiler: /usr/bin/cc
45-
-- Check for working C compiler: /usr/bin/cc -- works
46-
-- Detecting C compiler ABI info
47-
-- Detecting C compiler ABI info - done
48-
-- Detecting C compile features
49-
-- Detecting C compile features - done
50-
-- Check for working CXX compiler: /usr/bin/c++
51-
-- Check for working CXX compiler: /usr/bin/c++ -- works
52-
-- Detecting CXX compiler ABI info
53-
-- Detecting CXX compiler ABI info - done
54-
-- Detecting CXX compile features
55-
-- Detecting CXX compile features - done
56-
-- Found BZip2: /usr/lib64/libbz2.so (found version "1.0.6")
57-
-- Looking for BZ2_bzCompressInit
58-
-- Looking for BZ2_bzCompressInit - found
59-
60-
ADIOS2 build configuration:
61-
C++ Compiler: GNU 6.3.1
62-
/usr/bin/c++
63-
64-
Installation prefix: /usr/local
65-
Features:
66-
Library Type: shared
67-
Build Type: Debug
68-
Testing: ON
69-
MPI: OFF
70-
BZip2: ON
71-
ADIOS1: OFF
72-
DataMan: OFF
73-
74-
-- Configuring done
75-
-- Generating done
76-
-- Build files have been written to: /path/to/adios/build
77-
$
78-
```
79-
You can also use CMake's curses-base UI with `ccmake ../source`.
80-
81-
3. Compile:
82-
```
83-
$ make -j8
84-
```
85-
4. Run tests:
86-
```
87-
$ make test
88-
```
31+
32+
```
33+
$ mkdir build
34+
```
35+
36+
3. ***Configure the project with CMake***. The following options can be specified as `ON` or `OFF` with cmake's `-DVAR=VALUE` syntax, where VAR options are:
37+
38+
* `ADIOS_BUILD_SHARED_LIBS` - Build shared libraries (`OFF` for static)
39+
* `ADIOS_BUILD_EXAMPLES ` - Build examples
40+
* `ADIOS_BUILD_TESTING ` - Build test code
41+
* `ADIOS_USE_MPI ` - Enable MPI
42+
* `ADIOS_USE_BZip2 ` - Enable [BZip2](http://www.bzip.org/) compression
43+
* `ADIOS_USE_ZFP ` - Enable [ZFP](https://github.com/LLNL/zfp) compression
44+
* `ADIOS_USE_ADIOS1 ` - Enable the [ADIOS 1.x](https://www.olcf.ornl.gov/center-projects/adios/) engine
45+
* `ADIOS_USE_DataMan ` - Enable the DataMan engine for WAN transports
46+
* `ADIOS_USE_Python ` - Enable the Python bindings
47+
48+
***Important, automatic discovery***: ADIOS 2.0 CMake has an AUTO discovery "ON" default option. If a certain dependency is found in the system installation path (_e.g._ /usr/), not a custom one (_e.g._ /home , /opt ) it will turn on installation for that dependency automatically
49+
50+
In addition, the -DCMAKE_VAR frequent options can be selected:
51+
* `CMAKE_INSTALL_PREFIX ` - Prefix location for installation with `make install`, default depends on system (_e.g._ /usr/local)
52+
* `CMAKE_BUILD_TYPE ` - Debug (default, debugging symbols), or Release (compiler optimizations)
53+
54+
Example:
55+
```
56+
$ cd build
57+
$ cmake -DADIOS_USE_MPI=ON -DADIOS_USE_BZip2=ON -DCMAKE_BUILD_TYPE=Debug ../ADIOS2
58+
-- The C compiler identification is GNU 6.3.1
59+
-- The CXX compiler identification is GNU 6.3.1
60+
-- Check for working C compiler: /usr/bin/cc
61+
-- Check for working C compiler: /usr/bin/cc -- works
62+
-- Detecting C compiler ABI info
63+
-- Detecting C compiler ABI info - done
64+
-- Detecting C compile features
65+
-- Detecting C compile features - done
66+
-- Check for working CXX compiler: /usr/bin/c++
67+
-- Check for working CXX compiler: /usr/bin/c++ -- works
68+
-- Detecting CXX compiler ABI info
69+
-- Detecting CXX compiler ABI info - done
70+
-- Detecting CXX compile features
71+
-- Detecting CXX compile features - done
72+
-- Found BZip2: /usr/lib64/libbz2.so (found version "1.0.6")
73+
-- Looking for BZ2_bzCompressInit
74+
-- Looking for BZ2_bzCompressInit - found
75+
76+
ADIOS2 build configuration:
77+
C++ Compiler: GNU 6.3.1
78+
/usr/bin/c++
79+
80+
Installation prefix: /usr/local
81+
Features:
82+
Library Type: shared
83+
Build Type: Debug
84+
Testing: ON
85+
MPI: OFF
86+
BZip2: ON
87+
ADIOS1: OFF
88+
DataMan: OFF
89+
90+
-- Configuring done
91+
-- Generating done
92+
-- Build files have been written to: /path/to/adios/build
93+
$
94+
```
95+
96+
You can also use CMake's curses-base UI with `ccmake ../source`.
97+
98+
4. Compile:
99+
100+
```
101+
$ make -j8
102+
```
103+
104+
5. Run tests:
105+
106+
```
107+
$ make test
108+
```
89109

90110
## Developers
91111

92-
Please see the [Contributors Guide](Contributing.md) for how to submit changes
93-
to ADIOS.
112+
To summit changes to ADIOS 2.0: please see the wiki https://github.com/ornladios/ADIOS2/wiki Contributing to ADIOS section, or the local [Contributors Guide](Contributing.md).

0 commit comments

Comments
 (0)