Please review any and all PUBLIC repositories, groups and associate files. These allow anyone on the Internet to access without authentication. Repository and group owners are responsible for their content and permission settings. Go to your project(s), click on Settings > General and expand the "Visibility, project features, permissions" to change this setting.

Commit 93817f06 authored by Wigal, Jacob (CIV)'s avatar Wigal, Jacob (CIV)

adjusted spacing

parent 909e9098
......@@ -109,8 +109,7 @@
"</ul> \n",
"\n",
"<i>If we make a commit with these files, we won't be able to see the diff!</i>\n",
" <br>\n",
" <br>\n",
" <br><br>\n",
"Below is an example of a diff generated after committing files associated with a binary datatype called a <i>shapefile</i>. Here, we made changes to three binary files associated with a shapefile &hyphen; the database file(.dbf), the the main file (.shp), and the index file (.shx). Each file can have commits made and the user can move freely through this commit history. However, <b>the diff cannot show what changed</b>. The user is stuck with figuring out the differences between the original file and this new version. The only information provided is the commit message, \"Added point and changed date\". For large files, this limited information may not be useful enough to track changes. It is often difficult to manage large, distributed projects without seeing the diffs.\n",
" </font>"
]
......@@ -127,7 +126,6 @@
"metadata": {},
"source": [
"<h2>What text-based files should we use?</h2>\n",
"<br>\n",
"<h3>Storing and Sharing Code</h3>\n",
"<p>\n",
"<font size=\"3\">\n",
......@@ -141,21 +139,19 @@
"metadata": {},
"source": [
"<h3>Storing and Sharing Data</h3>\n",
"\n",
"<p>\n",
"<font size=\"3\">\n",
"The two biggest constraints when using git to manage data is: git requires limited file size and only text-based filetypes generate diffs.\n",
"<br><br>\n",
"<br>\n",
"\n",
"<b>Data File Size:</b> When storing code and and data on GitLab, the files are stored in <i>repositories</i>. Because git and GitLab were designed for managing text-based code (which often has very small file size), git repositories tend to have limitations on their total storage. However, there is generally no limitation on the number of repositories one can have. So, this issue is usually circumvented by keeping each repository as small as possible. When using git, its important to know the maximum storage capacity on a repository, and try and segment projects and data into separate repositories when possible.\n",
"<br><br>\n",
"<br>\n",
"\n",
"<b>Data Filetype:</b> While software development is done almost exclusively with flat, text-based files, data is often stored in non-flat, non-text-based files. A common example of a non-flat file would be an excel file with functions and data stored across multiple tabs. A common example of non-text-based data includes the binary shapefiles shown above. \n",
"<br>\n",
" <ul>\n",
"<b>To utilize git for data management, we have to use flat, text-based data filetypes whenever possible.</b> In general, this just means choosing an appropriate filetype for a particular kind of data and being deliberate about using that filetypes for all commits. To demonstrate what we mean, we will focus on an important type of data we want to share that comes in many filetypes &ndash; geospatial data.\n",
" </ul> </p>\n",
"<br>\n",
"\n"
]
},
......@@ -170,7 +166,6 @@
" <p>\n",
"Notice that there binary filetypes like shapefiles, geopackages, and kml/kmz <i>and</i> flat, text-based filetypes like geojson, wkt, and gml. When we use git, if we commit and share geospatial data as on of these text-based filetypes, we will get useful diffs. We highlight GeoJSON, because this is the flat, text-based filetype we chose from this list to use. We chose GeoJSON for a number of reasons.\n",
"</p>\n",
"<br>\n",
"<h3>GeoJSON</h3>\n",
"<font size=\"3\">\n",
"The GeoJSON format is the standard for text-based geospatial data formats. It is an open format, meaning it will work on most operating systems and GIS software. It is built on top of the already well-established JSON format, and has a number of helpful supporting packages that can be employed in programming languages such as Python and R.\n",
......@@ -186,7 +181,6 @@
" <font size=\"3\">\n",
"We are using git and GitLab with the text-based geospatial data format GeoJSON.\n",
" <br>\n",
" <br>\n",
" <h3>Frequently Asked Questions:</h3><br> \n",
" <i>\"But I have always used shapefiles. Is there some sort of disadvantage?\"</i><br>\n",
"\n",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment