Skip to content

Commit 377defd

Browse files
authored
Update README.md
Minor edits to README markdown
1 parent be5e1dd commit 377defd

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[![Test CI](https://github.com/jonmjonm/AtlasIO.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/jonmjonm/AtlasIO.jl/actions/workflows/ci.yml)
55

6-
This repository a number of tools to read in and manipulate Atlas files. The primary code is written in the Julia programming language, but it can be used in Python as well. The Python library can only read Atlas files, it cannot write them. The Julia library can read and write Atlas files.
6+
This repository contains a number of tools to read in and manipulate Atlas files. The primary code is written in the Julia programming language, but it can be used in Python as well. The Python library can only read Atlas files, it cannot write them. The Julia library can read and write Atlas files.
77

88
## Atlas files
99

@@ -38,7 +38,7 @@ LICENSE
3838
```
3939
## The files contained here are :
4040
* README.md :
41-
This file. It contains a description of the repository and how to use it.
41+
This file contains a description of the repository and how to use it.
4242
* atlas_format.md :
4343
This file contains a description of the Atlas file format. It describes the JSONL format and the different fields in the JSON objects.
4444
* LICENSE :
@@ -54,15 +54,15 @@ LICENSE
5454
- test.jsonl :
5555
This is a small hand made collection of map assignments for testing. Notice that it is compressed. The library can read compressed or uncompressed files.
5656
- atlas_measureID.jsonl.gz :
57-
This is a large collection of map assignments for testing. Notice that it is compressed. The library can read compressed or uncompressed files. These multi-scale assignments come from code which try to preserve the different levels. This ensembles was used in NC 2021 court case. More info can be found in the [original repos](https://git.math.duke.edu/gitlab/gjh/ncanalysis2020/-/tree/main/ensembles/congressional)
57+
This is a large collection of map assignments for testing. Notice that it is compressed. The library can read compressed or uncompressed files. These multi-scale assignments come from code which try to preserve the different levels. This ensembles was used in a North Carolina 2021 court case. More info can be found in the [original repos](https://git.math.duke.edu/gitlab/gjh/ncanalysis2020/-/tree/main/ensembles/congressional).
5858
* PythonReader Directory : This directory contains python code to read Atlas files and analyze them.
5959
- Atlas.py :
6060
This is the main Atlas reader Library. It is a python version of the Julia library. It can read compressed or uncompressed files. It can not write an Atlas file presently. Use the Julia library to write an Atlas file.
6161
- helper_functions.py :
6262
Some helper functions that are useful. Examples include summing elections, performing uniform swings and obtaining the node name to district mapping. See the file for full list and description.
6363

6464
* Shapefiles_JSON Directory :
65-
This contains some election data and the adjacency data. Some files are in JSON files others are in ziped shapefiles.
65+
This contains some election data and the adjacency data. Some files are in JSON files and others are in zipped shapefiles.
6666

6767
* PythonExamples Directory :
6868
This directory contains some examples of how to use the Atlas reader library.

0 commit comments

Comments
 (0)