You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+3-16
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,6 @@ If you are using NIAS for the purposes of NAPLAN validation or postprocessing, y
13
13
*[NAPRRQL CSV and Reporting Output Outline](https://github.com/nsip/nias2/blob/master/app/naprrql/NAPRRQLToolsetCsvAndReportingOutput_v06.pdf)
14
14
*[NAPCOMP Readme](https://github.com/nsip/nias2/blob/master/napcomp/README.md) (Audit of registration data against reporting data)
15
15
16
-
The [NIAS2AG](https://github.com/nsip/nias2ag) repository hosts NIAS open-source components to be used for Australian Government data collections.
17
-
18
16
# 1. Overview
19
17
20
18
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.
62
60
63
61
* 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
64
62
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
66
64
* For Linux, ```ulimit -n 2048```
67
65
68
66
# 2. Installation
@@ -90,31 +88,24 @@ In `$GOPATH/src/github.com/nsip` do:
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)
94
92
95
93
# 3. Code Structure
96
94
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)
102
96
103
97
`unit_test_files/`
104
98
* Contains files used in unit/integration testing of the code. Currently restricted to CSV files input into the validation module.
105
99
106
100
`build.sh`, `build/`, `release.sh`
107
101
*`build.sh` builds all NIAS2 executables for the various supported platforms
108
-
*`build_sms.sh` builds the SSF and SMS application
109
102
*`build_napval.sh` builds the NAPVAL application
110
103
*`build_naprrql.sh` builds the NAPRRQL application
111
104
The builds for each platform are built in `build/{PLATFORM}/{APP}/`.
112
105
113
106
#### The supported platforms are:
114
107
* Mac OSX
115
-
* Windows 32 bit
116
108
* Windows 64 bit
117
-
* Linux 32 bit
118
109
* Linux 64 bit
119
110
120
111
`bin/`
@@ -130,7 +121,6 @@ Contains utilities for managing NIAS2
130
121
131
122
`app/`
132
123
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)
134
124
*`napval/` : NAPLAN Registration records validation
135
125
*`naprrql/` : NAPLAN Results and Reporting post-processing
136
126
*`napcomp/` : Comparison of students between NAPLAN Registration and NAPLAN Results and Reporting (included in `naprrql` distribution)
@@ -141,9 +131,6 @@ NAPLAN Registration records validation
141
131
`naprrql/`
142
132
NAPLAN Results and Reporting post-processing
143
133
144
-
`sms/`
145
-
SIF Memory Store functionality of NIAS
146
-
147
134
`xml/`
148
135
Golang structs corresponding to SIF XML objects relevant to executables. Currently limited to NAPLAN-specific objects.
0 commit comments