Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jpn-- committed Jan 21, 2022
1 parent 43aa1ff commit 1cb115d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 4 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2021, Jeffrey Newman
Copyright (c) 2022, Association of Metropolitan Planning Organizations Research Foundation
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
6 changes: 5 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Learn more at https://jupyterbook.org/customize/config.html

title: v2022.0.1
author: <a href="https://www.camsys.com">Cambridge Systematics</a> for the <a href="https://activitysim.github.io/">ActivitySim
author: Sharrow contributors, for the <a href="https://activitysim.github.io/">ActivitySim
Consortium</a>
logo: logo.png
copyright: 2022 AMPO Research Foundation # Copyright year to be placed in the footer
Expand Down Expand Up @@ -48,3 +48,7 @@ sphinx:
repository_branch: master
path_to_docs: docs
extra_navbar:
favicons:
- rel: icon
sizes: 32x32
href: favicon.png
Binary file added docs/_static/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ to have `loc` and `iloc` functionality enabled. This only works for indexing on
the rows, but if there's only the one dimension the complexity of `sel` and `isel`
are not needed.

.. automethod:: sharrow.Dataset.loc
.. automethod:: sharrow.Dataset.iloc
.. autoattribute:: sharrow.Dataset.loc
.. autoattribute:: sharrow.Dataset.iloc

Shared Memory
~~~~~~~~~~~~~
Expand Down
11 changes: 11 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ together in the same lane. It leverages the power of numba and xarray to
compile expression specification files (like those used in ActivitySim) into
optimized, runnable code.

## ActivitySim

Sharrow is a project of the [ActivitySim](https://activitysim.github.io/) consortium.

The mission of the ActivitySim Consortium is to create and maintain advanced,
open-source, activity-based travel behavior modeling software based on best
software development practices for distribution at no charge to the public.

## Installation

Expand Down Expand Up @@ -58,3 +65,7 @@ Then to build the docs, in the root directory of the sharrow repository run
```shell
jb build docs
```

## License

Sharrow is available under the open source [3-Clause BSD License](https://opensource.org/licenses/BSD-3-Clause).

0 comments on commit 1cb115d

Please sign in to comment.