Difference between revisions of "OSGeoLive"

From OSGeo
Jump to navigation Jump to search
(link to OSGeo gogs git)
Line 145: Line 145:
  
 
== OSGeo User Id ==
 
== OSGeo User Id ==
−
* Create an OSGeo id: http://www.osgeo.org/osgeo_userid , which is required to edit the wiki, commit to [[https://git.osgeo.org/gogs | git]] and create an issue in the issue tracker.
+
* Create an OSGeo id: http://www.osgeo.org/osgeo_userid , which is required to edit the wiki, commit to [https://git.osgeo.org/gogs | git] and create an issue in the issue tracker.
  
 
== Git migration ==
 
== Git migration ==

Revision as of 11:54, 26 November 2017

About OSGeoLive

Osgeolive wordle.png

OSGeoLive provides bootable ISO-Images and Virtual Machines which allow users to try out fully-operational versions of popular Free Geospatial Software without the need to install a thing.

We do this in large part by maintaining automated build scripts which collect many OSGeo programs and sample data-sets together, and then combine them to form the Live disc or VM itself. By tweaking these scripts, users are free to make their own custom distributions, for example localized in their own language and with local map data.

Key Links

Quick Start

How to add a project to OSGeoLive

Including OSGeoLive at your event

OSGeoLive provides a DVD, USB and a Virtual Machine which allow users to try out fully-operational versions of popular Free Geospatial Software without the need to install a thing. It also includes documentation and a comprehensive presentation.

This is the process to follow if you wish to make use of OSGeoLive at your conference, workshop or similar event.

Tell Us
Add your event to our OSGeoLive History page and tell us how you would like to use OSGeoLive on our email list (or email Cameron Shorter directly). Hearing how OSGeoLive is used motivates us to keep going, and we plan releases around upcoming events.
Presentation
Conference attendees appreciate the OSGeoLive Lightning Overview, which explains the breadth of OSGeo software, abstract here. It is often presented by one of the conference organisors, or keynote speakers. You may wish to find a suitable speaker from the OSGeo Advocate list. The presentation may be given as is, or modified to align with time constraints, presenter's interest, or conference focus. (For prior variants, see Live GIS Presentation.)
Handing out USBs or DVDs
OSGeoLive DVDs and/or USBs are often handed out to all conference delegates, or a smaller number handed out from an OSGeo booth. DVDs are cheaper (around $2 per copy), but USBs provide a better experience as they are faster to boot up and run. You will need to:
  1. Work out how to pay for the USBs/DVDs. Usually the price is factored into event budgets. This means you will require commitment from the event Organisors. However you may find an external sponsor, or for smaller print runs, you might find volunteers to print from their computers.
  2. Source a local printer, preferably local. Printers typically require 2 weeks to do the print run, although they often will turn around faster if you pay more money.
  3. Printing DVDs: The printer will require an ISO image, and artwork for the DVD face and DVD sleeve. You may make use of existing artwork or create your own.
  4. Printing USBs: A 4 Gig USB is required for osgeo-live-mini (8 Gig if you wish the full image with windows and mac installers). The process for installing USBs is described here. Note that it is important to ask the printer if they can create bootable USBs. (We have found that many printers are not familiar with the process). It is prudent to check the first USB that is printed before printing the rest. You can also print a logo on the USB.
Workshops
For workshops, we recommend using OSGeoLive from a Virtual Machine or from a USB. Note that some computers can't boot from a USB. OSGeoLive on a DVD is slow and as such is not recommended for workshops. However it is wise to have a few spare DVDs in case one of your computers can't boot from the USB. Note that OSGeoLive we have heard some issues when running on Apple Macs, so if using Macs, please test first.
Poster
We have a Poster which is useful for hanging on a wall of a conference booth.

Build Process

Want to help?

We love volunteers, and would love to hear from you if you would like to help out. Best place to start is to introduce yourself on our email list, maybe mention how you'd like to get involved. Here are some ideas about things that you might want to help with:

Translations
Know another language? Why not join our team of translators:
http://wiki.osgeo.org/wiki/Live_GIS_Disc#Translate
Testing
Quickstarts
Debian Packaging

Project Management Committee (PMC)

Also referred to as Project Steering Committee (PSC)

Package List

Documentation

Live_GIS_Add_Project#Documentation

Stable release: http://live.osgeo.org

Nightly build: http://adhoc.osgeo.osuosl.org/livedvd/docs/en/index.html

Source is stored in git: https://github.com/OSGeo/OSGeoLive-doc

OSGeo Live V11 translation guidelines Was never used, need someone with sysop rights to delete the page

Notebooks

Live_GIS_Add_Project#Notebooks

In development Notebooks

Translate

Artwork

You can find the artwork sleeves, background images, booklet at:


Version 4.5

Review

Presentation

Live GIS Presentation

Poster

OSGeoLive Poster

Workshops with OSGeoLive

Workshops with OSGeoLive

USB Creation

Schedule

Contact Us

The mailing list is archived at Gmane and Nabble

Downloads

Latest Stable Release: http://live.osgeo.org/en/download.html

Latest Development Release: http://aiolos.survey.ntua.gr/gisvm/dev/

Older Releases: http://download.osgeo.org/livedvd

Issue Tracker

Our issue tracker is UNDER CONSTRUCTION nov17 hosted at OSGeo's Trac system, and you will need to create an OSGeo UserId before you can login and edit issues. To distinguish the LiveDVD project from other OSGeo projects, use the following conventions:

Component field
Set to `LiveDVD`
Keywords
Version: Set to base release version: eg: 5.0, 5.5 (not 5.5rc1)
Application: Set to application with issue (use lower case): eg: "geoserver"
List of open tickets

OSGeo User Id

Git migration

Repositories (to be moved to OSGeo infrastructure soon)
https://github.com/OSGeo/OSGeoLive and https://github.com/OSGeo/OSGeoLive-doc
  • Since Git is a distributed versioning system, it is very convenient for each developer/contributor to have a personal public copy of the "official" repository (also known as fork).
  • Web hosting services like GitLab or GitHub provide this option if you visit the main code repository and press the button "Fork". This way the developer can make changes to a personal isolated repository. Then one can ask the rest of the developers to review the code and merge accordingly through a "pull request".
  • On Linux systems get the source code locally using:
git clone https://github.com/your_id/OSGeoLive
  • In order to be able to get and send changes to your public repository, you need to link your local copy to your public copy. This is done automatically for you when you "git clone". The repository that you cloned from has the alias "origin".
  • In order to be able to get changes that others do to the main repository, you need to manually link to that using:
git remote add upstream https://github.com/OSGeo/OSGeoLive
  • On MS Windows systems, install TortoiseGit, which extends Windows Explorer to include git commands.
  • The first thing you should do when you install Git is to set your user name and e-mail address.
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
Commit access
On the git world, you don't need commit access to the main repository in order to contribute. You just work on your own fork and ask maintainers to merge your code through "pull requests". Before you contribute to the project for the first time, you will need to confirm that you will comply with our license guidelines. Write something like:
"Hi all, I'd like to contribute XXX to OSGeoLive. I confirm that my contributions to OSGeoLive will be compatible with the OSGeoLive license guidelines at the time of contribution."


The licenses used for the OSGeoLive build scripts and documentation are:
  • Creative Commons Attribution-ShareAlike 3.0 Unported License for Quickstarts
  • Creative Commons Attribution 3.0 Unported License for Project Overviews
  • LGPL version >=2.1 for the install scripts
  • One of the OSI approved Open Source licenses for installed applications
  • Public domain, CC-By-SA, and Open Data Commons Open Database License (ODbL) for data
Add your name to contributors list
The first thing you should do to test your git setup is to add your name to the code contributors or translators list(s):
cd OSGeoLive-doc

# Pull any updates from upstream project (master is the equivalent of subversion trunk)
git pull upstream master

# Coders and creators of new content: edit contributors.csv
# please add your Name, Email, Country and Osgeo_id to the list, separated by comma
#  - Order alphabetical by first name,
#  - remove punctuation from email addresses to stop harvesting for junk mail

# optionally check to see what has changed.
git diff contributors.csv

# add the changes into stage area
git add contributors.csv

# commit changes locally
git commit -m "Added [my name] to contributors"

# send the changes to your public repository 
git push origin master

At this point you can let others know that you have some changes that you want to merge, so you can use the button "Pull Request" on GitLab or GitHub. Or you can continue until you feel ready to share your code :) 

# Translators: edit translators.csv
# same as above, but the order of columns is:
# Language, i18n code, Name, Country, Email, Osgeo_id
#  - Order alphabetically by language, then by first name
#  - remove punctuation from email addresses to stop harvesting for junk mail

Working with files: 

# to add a file
cd <dir>

# create a file
git add <file>
git commit -m "commit message"
git push origin master

# to move or rename a file
#  *** please use instead of 'svn add' + 'svn rm', otherwise the
#      development history gets lost and database space is wasted ***
git mv <old filename> <new filename>
git commit -m "commit message"
git push origin master


Last step: pull request

In order to merge your work with the main repository, you have to make a pull request.

You can do it by logging on your github account and go to the branch you changed. Click on the New pull request green button. The changes you made previously while appear.

You can review and comment your request before submitting. To submit, click on the Create pull request green button. Then, you're done ! Good job !

More information about Github pull request here: https://help.github.com/articles/using-pull-requests/

Subversion

Repository
https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk and web view
  • On Linux systems: access Subversion using:
svn checkout https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk
  • On MS Windows systems, install Tortoise Subversion, which extends Windows Explorer to include subversion commands.
Commit access
To get commit access, you need to create yourself an osgeo user id, then join our email list and ask to be given access to subversion. In this email, you will also need to confirm that you will comply with our license guidelines. Write something like:
"Hi all, I'd like to contribute XXX to OSGeoLive. Could I please get access to subversion. My osgeo-user id is: YYYY.
I confirm that my contributions to OSGeoLive will be compatible with the OSGeoLive license guidelines at the time of contribution."


The licenses used for the OSGeoLive build scripts and documentation are:
  • Creative Commons Attribution-ShareAlike 3.0 Unported License for Quickstarts
  • Creative Commons Attribution 3.0 Unported License for Project Overviews
  • LGPL version >=2.1 for the install scripts
  • One of the OSI approved Open Source licenses for installed applications
  • Public domain, CC-By-SA, and Open Data Commons Open Database License (ODbL) for data
A project admin will then add you to the osgeo user group.
Add your name to contributors list
The first thing you should do to test your svn install is to add your name the code contributors or translators list(s):
cd trunk/doc

# to edit a file
svn update contributors.csv translators.csv

# Coders and creators of new content: edit contributors.csv
# please add your Name, Email, Country and Osgeo_id to the list, separated by comma
#  - Order alphabetical by first name,
#  - remove punctuation from email addresses to stop harvesting for junk mail

# optionally check to see what has changed.
svn diff contributors.csv

# check the file back into subversion
svn commit contributors.csv

# Translators: edit translators.csv
# same as above, but the order of columns is:
# Language, i18n code, Name, Country, Email, Osgeo_id
#  - Order alphabetically by language, then by first name
#  - remove punctuation from email addresses to stop harvesting for junk mail

Working with files: 

# to add a file
cd <dir>

# create a file
svn add <file>
svn propset svn:mime-type <mime.type> <file>
svn commit <file>

# to move or rename a file
#  *** please use instead of 'svn add' + 'svn rm', otherwise the
#      development history gets lost and database space is wasted ***
svn move <old filename> <new filename>
svn commit <file>
  • A script to automatically set the svn props can be found here. More SVN hints here.
  • On MS Windows this can be made easy using Tortoise SVN which plugs directly into Windows Explorer.

FAQ

Code of Conduct

Within the OSGeoLive community we act respectfully toward others in line with the OSGeo Code of Conduct.

Press Releases


Twitter

We also announce press releases on twitter.

  • Major Builds
  • Calls for Testing
  • Calls for Translation
  • Retweets of events featuring OSGeoLive

Twitter Account

History

Live GIS History

Testimonials

OSGeoLive_Testimonials

Project Metrics

Google Summer of Code

OSGeo Incubation

Use Cases

There are multiple use cases for this product:

  • Demo DVD/USB that can be handed out at conferences.
    This will contain a wide variety of applications, preconfigured with some sample data and containing introductory tutorials. It should be able to function completely offline, at least within the scope of the tutorials, and should provide an introduction to many products. This is very much a Live DVD, and as such should be conservative with regards to size (it will be run from RAM).
  • Education DVD
    This seems to be a more involved version than the Demo DVD, including more involved material, including train-the-trainer style material. This is targeted at those who will be teaching others, be it in workshops or university classes/labs. My expectation (mleslie: feel free to correct me) is that this is more likely to be installed on machines and used as a teaching resource, as opposed to a toy to play with, as with the Demo DVD. This will require material developed through the.
  • Workstation Install DVD
    This need was seen in Cape Town, where the bandwidth seems to be a very limiting factor. Using the DVD to install either a complete OS, a set of packages to an existing Linux, or Windows installers completely offline is of great value in the developing world. Would it be of greater value to lose the Edu or demo material and put in complete application documentation?

Links to related projects

Build scripts in DebianGIS's SVN

Links to Build tool options

Retrieved from "http://wiki.osgeo.org/w/index.php?title=OSGeoLive&oldid=111237"