From a9b357ee332dbcb7fa6110fb1f910603e49c42b1 Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 23 Jun 2021 14:28:35 -0400 Subject: [PATCH 1/8] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c6f61367..a10f5d0d 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,16 @@ ## Installation -Requires Linux/MacOS, git, and Python 3.6+ + +### Supported Platforms + +- Linux +- MacOS + +### Dependencies + +- `git` +- `python>=3.7` ### 1) Clone From e590713b205650914b0b5be17b19848ef168e44b Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 23 Jun 2021 14:30:03 -0400 Subject: [PATCH 2/8] Update README.md --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index a10f5d0d..428c940c 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,6 @@ - Linux - MacOS -### Dependencies - -- `git` -- `python>=3.7` - ### 1) Clone - Clone this repo to your local machine using: From 684b24ff67f124da29152e0153be885c95c3c566 Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 23 Jun 2021 14:35:05 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 428c940c..28a43fc1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) -[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE) ![Linux CI](https://github.com/argoai/argoverse-api/workflows/Python%20CI/badge.svg) From e91bb1cf99e35b18bbc31dbd5269c44c2d52d7eb Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 23 Jun 2021 14:37:43 -0400 Subject: [PATCH 4/8] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 28a43fc1..dbd3ec28 100644 --- a/README.md +++ b/README.md @@ -66,14 +66,15 @@ We provide both the full dataset and the sample version of the dataset for testi Note that you need to download HD map data (and extract them into project root folder) for the API to function properly. You can selectively download either **Argoverse-Tracking** or **Argoverse-Forecasting** or both, depending on what type of data you need. The data can be extracted to any location in your local machine. -### 4) Install argoverse module +### 4) Install `argoverse` package * `argoverse` can be installed as a python package using pip install -e /path_to_root_directory_of_the_repo/ -* if you receive any error about `No matching distribution found for pyntcloud`, upgrade your pip using `pip install --upgrade pip` or pip install with `--process-dependency-links` -Make sure that you can run `python -c "import argoverse"` in python, and you are good to go! +### 5) Verify install + +`python -c "import argoverse"` ### (optional) Install mayavi * Some visualizations may require `mayavi`. See instructions on how to install Mayavi [here](https://docs.enthought.com/mayavi/mayavi/installation.html). From 6e9f6ef5a638647808e19a6659217d7197bbbbcc Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 30 Jun 2021 16:55:08 -0400 Subject: [PATCH 5/8] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index dbd3ec28..12a396cc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) +[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE) ![Linux CI](https://github.com/argoai/argoverse-api/workflows/Python%20CI/badge.svg) From 7de40ed780557d59c7d0b51613a90fae6e63bfa8 Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 30 Jun 2021 17:05:29 -0400 Subject: [PATCH 6/8] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 12a396cc..dac348a9 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,8 @@ Note that you need to download HD map data (and extract them into project root f pip install -e /path_to_root_directory_of_the_repo/ +Make sure that you can run `python -c "import argoverse"` in python, and you are good to go! + ### 5) Verify install `python -c "import argoverse"` From e7018f5c63e1c86ed3d3be02abeb36aa5420f699 Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 30 Jun 2021 17:08:33 -0400 Subject: [PATCH 7/8] Update README.md --- README.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/README.md b/README.md index dac348a9..ddd96b82 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,6 @@ ## Installation - -### Supported Platforms - - Linux - MacOS @@ -67,7 +64,7 @@ We provide both the full dataset and the sample version of the dataset for testi Note that you need to download HD map data (and extract them into project root folder) for the API to function properly. You can selectively download either **Argoverse-Tracking** or **Argoverse-Forecasting** or both, depending on what type of data you need. The data can be extracted to any location in your local machine. -### 4) Install `argoverse` package +### 4) Install argoverse module * `argoverse` can be installed as a python package using @@ -75,10 +72,6 @@ Note that you need to download HD map data (and extract them into project root f Make sure that you can run `python -c "import argoverse"` in python, and you are good to go! -### 5) Verify install - -`python -c "import argoverse"` - ### (optional) Install mayavi * Some visualizations may require `mayavi`. See instructions on how to install Mayavi [here](https://docs.enthought.com/mayavi/mayavi/installation.html). From dff964b3baaa15cb19aff42eb48bf739a43b94cd Mon Sep 17 00:00:00 2001 From: Benjamin Wilson Date: Wed, 30 Jun 2021 17:09:38 -0400 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ddd96b82..16919c48 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ We provide both the full dataset and the sample version of the dataset for testi Note that you need to download HD map data (and extract them into project root folder) for the API to function properly. You can selectively download either **Argoverse-Tracking** or **Argoverse-Forecasting** or both, depending on what type of data you need. The data can be extracted to any location in your local machine. -### 4) Install argoverse module +### 4) Install argoverse package * `argoverse` can be installed as a python package using