forked from UDST/urbansim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,105 +1,33 @@ | ||
| UrbanSim | ||
| ======== | ||
|
|
||
| .. image:: https://img.shields.io/pypi/v/urbansim.svg | ||
| :target: https://pypi.python.org/pypi/urbansim/ | ||
| :alt: Latest Version | ||
|
|
||
| .. image:: https://travis-ci.org/UDST/urbansim.svg?branch=master | ||
| :alt: Build Status (Linux) | ||
| :alt: Build Status | ||
| :target: https://travis-ci.org/UDST/urbansim | ||
|
|
||
|
|
||
| .. image:: https://ci.appveyor.com/api/projects/status/0ygo756020jpcrg3?svg=true | ||
| :alt: Build Status (Windows) | ||
| :target: https://ci.appveyor.com/project/pksohn/urbansim | ||
|
|
||
|
|
||
| .. image:: https://coveralls.io/repos/UDST/urbansim/badge.png?branch=master | ||
| .. image:: https://coveralls.io/repos/UDST/urbansim/badge.svg?branch=master | ||
| :alt: Test Coverage | ||
| :target: https://coveralls.io/r/UDST/urbansim?branch=master | ||
|
|
||
| New version of UrbanSim, a tool for modeling metropolitan real estate | ||
| markets | ||
|
|
||
| .. image:: http://i.imgur.com/4YyN8ob.jpg | ||
| :alt: UrbanSim | ||
|
|
||
| `Detailed documentation <http://udst.github.io/urbansim/>`__ for | ||
| UrbanSim is now available. | ||
|
|
||
| `Click | ||
| here <http://udst.github.io/urbansim/gettingstarted.html#installation>`__ | ||
| for installation instructions. | ||
|
|
||
| Let us know what you are working on or if you think you have a great use case | ||
| by tweeting us at ``@urbansim`` or post on the UrbanSim `forum`_. | ||
|
|
||
| UrbanSim History | ||
| ---------------- | ||
|
|
||
| UrbanSim (http://www.urbansim.com) is a model system for analyzing | ||
| urban development. It is an open source platform that has been | ||
| continuously refined and distributed for planning applications around | ||
| the world for over 15 years. Part of the evolution of the platform is | ||
| the necessary process of re-engineering the code to take advantage of | ||
| new developments in computational libraries and infrastructure. We | ||
| implemented UrbanSim initially in Java in the late 1990's, and by 2005 | ||
| determined that it was time to re-implement it in Python, and created | ||
| the Open Platform for Urban Simulation (OPUS) software implementation at | ||
| that time. Now, almost a decade later, it is time again to revisit the | ||
| implementation to take advantage of an amazing amount of innovation in | ||
| the scientific computing community. The new implementation is hosted on | ||
| this GitHub site, and maintained by UrbanSim Inc. and a growing | ||
| community of contributors. | ||
|
|
||
| New UrbanSim Implementation | ||
| --------------------------- | ||
|
|
||
| This new code base is a streamlined complete re-implementation of the | ||
| longstanding UrbanSim project aimed at *reducing the complexity* of | ||
| using the UrbanSim methodology. Redesigned from the ground up, the new | ||
| library is trivial to install, the development process is made | ||
| transparent via this GitHub site, and exhaustive documentation has been | ||
| created in the hopes of making modeling much more widely accessible to | ||
| planners and new modelers. | ||
|
|
||
| We lean heavily on the `PyData <http://pydata.org>`__ community to make | ||
| our work easier - Pandas, `IPython <http://ipython.org/>`__, and | ||
| `statsmodels <http://statsmodels.sourceforge.net/>`__ are ubiquitous in | ||
| this work. These Python libraries essentially replace the UrbanSim | ||
| Dataset class, tools to read and write from other storage, and some of | ||
| the statistical estimation previously implemented by UrbanSim. | ||
|
|
||
| This makes our task easier as we can focus on urban modeling and leave | ||
| the infrastructure to the wider Python community. The | ||
| `Pandas <http://pandas.pydata.org>`__ library is the core of the new | ||
| UrbanSim, which is an extremely popular data manipulation library with a | ||
| large community providing support and a very helpful | ||
| `book <http://www.amazon.com/Python-Data-Analysis-Wes-McKinney/dp/1449319793>`__. | ||
|
|
||
| We have now converted a full set of UrbanSim models to the new | ||
| framework, and have running applications for the Paris, Albuquerque, | ||
| Denver, Bay Area, and Detroit regions. We have implemented a complete | ||
| set of hedonic price models, location choice models, relocation and | ||
| transition models, as well as a new real estate development model using | ||
| proforma analysis. | ||
| UrbanSim is a platform for building statistical models of cities and regions. These models help forecast long-range patterns in real estate development, demographics, and related outcomes, under various policy scenarios. | ||
|
|
||
| We do strongly recommend that you contact the team at www.urbansim.com about your | ||
| project to make sure you can get support when you need it, | ||
| and know what you are getting into. For major applied projects, | ||
| professional support is highly recommended. | ||
| This UrbanSim *Python library* is a core component. It contains tools for statistical estimation and simulation; domain-specific logic about housing markets, household relocation, and other processes; and frameworks and utilities for assembling a model. | ||
|
|
||
| Reporting bugs and contributing to UrbanSim | ||
| -------------------------------------------- | ||
| Operational UrbanSim models begin with detailed data about a particular region, and then estimate and validate a system of interconnected model components. Full models draw on a number of libraries: not just ``urbansim``, but also Orca for task orchestration, Synthpop for population synthesis, Pandana for network analysis, Developer for real estate logic, and so on. Collectively, these make up the `Urban Data Science Toolkit <https://github.com/UDST>`__ (UDST). | ||
|
|
||
| Please report any bugs you encounter via `GitHub Issues <https://github.com/UDST/urbansim/issues>`__. | ||
| UrbanSim models are used by public agencies, consultancies, and researchers in dozens of cities around the U.S. and world. The core platform is open source, but many operational models make use of additional cloud-hosted model building and visualization tools provided by UrbanSim Inc. | ||
|
|
||
| If you have improvements or new features you would like to see in UrbanSim: | ||
| Learn More | ||
| ---------- | ||
|
|
||
| 1. Open a feature request via `GitHub Issues <https://github.com/UDST/urbansim/issues>`__. | ||
| 2. See our code contribution instructions `here <https://github.com/UDST/urbansim/blob/master/CONTRIBUTING.md>`__. | ||
| 3. Contribute your code from a fork or branch by using a Pull Request and request a review so it can be considered as an addition to the codebase. | ||
| * `An Introduction to UrbanSim <https://udst.github.io/urbansim/gettingstarted.html#a-gentle-introduction-to-urbansim>`__ | ||
|
|
||
| Academic literature | ||
| ------------------- | ||
| * `Documentation <https://udst.github.io/urbansim/>`__ for the ``urbansim`` Python library | ||
|
|
||
| A selection of academic literature on UrbanSim can be found `here <http://www.urbansim.com/research/>`_. | ||
| * `UrbanSim for San Francisco: An example implementation <https://github.com/UDST/sanfran_urbansim>`__ | ||
|
|
||
| .. _forum: http://discussion.urbansim.com/ | ||
| * `UrbanSim Inc. <https://urbansim.com>`__ |