Skip to content

Commit 8e46dcd

Browse files
committed
update readme, PDF
1 parent b486261 commit 8e46dcd

File tree

2 files changed

+3
-16
lines changed

2 files changed

+3
-16
lines changed

README.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ If you are using NIAS for the purposes of NAPLAN validation or postprocessing, y
1313
* [NAPRRQL CSV and Reporting Output Outline](https://github.com/nsip/nias2/blob/master/app/naprrql/NAPRRQLToolsetCsvAndReportingOutput_v06.pdf)
1414
* [NAPCOMP Readme](https://github.com/nsip/nias2/blob/master/napcomp/README.md) (Audit of registration data against reporting data)
1515

16-
The [NIAS2AG](https://github.com/nsip/nias2ag) repository hosts NIAS open-source components to be used for Australian Government data collections.
17-
1816
# 1. Overview
1917

2018
NIAS is a suite of open-source components designed to enable as many different users as possible to quickly and easily solve issues of system integration using the Australian [SIF Data Model](http://specification.sifassociation.org/Implementation/AU/1.4/html/) for school education.
@@ -62,7 +60,7 @@ The product does not incorporate authentication or authorisation.
6260

6361
* The key-value database in the product needs to be able to process a large number of open files; if you will be running NIAS on Mac/Linux with production-scale
6462
numbers of students in the results & reporting file, you will need to increase your `ulimit` setting; we recommend 2048.
65-
* For Mac, see https://blog.dekstroza.io/ulimit-shenanigans-on-osx-el-capitan/
63+
* For Mac, see https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c
6664
* For Linux, ```ulimit -n 2048```
6765

6866
# 2. Installation
@@ -90,31 +88,24 @@ In `$GOPATH/src/github.com/nsip` do:
9088

9189
## 2.4. Running NAPLAN Results & Reporting modules
9290

93-
Separate executables are run to process NAPLAN data; see [NAPVAL readme](./napval/README.md), [NAPRR readme](./naprr/README.md)
91+
Separate executables are run to process NAPLAN data; see [NAPVAL readme](./napval/README.md), [dev-nrt readme](https://github.com/nsip/dev-nrt), [dev-nrt-splitter readme](https://github.com/nsip/dev-nrt-splitter)
9492

9593
# 3. Code Structure
9694

97-
See also [NAPRR readme](./naprr/README.md), [NAPLVAL readme](./napval/README.md)
98-
99-
NIAS2 relies on the following infrastructure:
100-
* [ledis](http://ledisdb.com), a NoSQL database similar to [redis](http://redis.io)
101-
* xmllint, an XML validator included in the [libxml](http://xmlsoft.org) package
95+
See also [dev-nrt readme](./naprr/README.md), [NAPVAL readme](./napval/README.md)
10296

10397
`unit_test_files/`
10498
* Contains files used in unit/integration testing of the code. Currently restricted to CSV files input into the validation module.
10599

106100
`build.sh`, `build/`, `release.sh`
107101
* `build.sh` builds all NIAS2 executables for the various supported platforms
108-
* `build_sms.sh` builds the SSF and SMS application
109102
* `build_napval.sh` builds the NAPVAL application
110103
* `build_naprrql.sh` builds the NAPRRQL application
111104
The builds for each platform are built in `build/{PLATFORM}/{APP}/`.
112105

113106
#### The supported platforms are:
114107
* Mac OSX
115-
* Windows 32 bit
116108
* Windows 64 bit
117-
* Linux 32 bit
118109
* Linux 64 bit
119110

120111
`bin/`
@@ -130,7 +121,6 @@ Contains utilities for managing NIAS2
130121

131122
`app/`
132123
Contains the code to run executables within NIAS as single pieces of software, along with necessary configuration files, and test executables. The configuration fields are copied into the binary distributions of NIAS.
133-
* `sms/` : the SIF Memory Store functionality of NIAS (ported from Ruby)
134124
* `napval/` : NAPLAN Registration records validation
135125
* `naprrql/` : NAPLAN Results and Reporting post-processing
136126
* `napcomp/` : Comparison of students between NAPLAN Registration and NAPLAN Results and Reporting (included in `naprrql` distribution)
@@ -141,9 +131,6 @@ NAPLAN Registration records validation
141131
`naprrql/`
142132
NAPLAN Results and Reporting post-processing
143133

144-
`sms/`
145-
SIF Memory Store functionality of NIAS
146-
147134
`xml/`
148135
Golang structs corresponding to SIF XML objects relevant to executables. Currently limited to NAPLAN-specific objects.
149136

Binary file not shown.

0 commit comments

Comments
 (0)