Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FAQ.md #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions docs/Docker-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron
nvidia-smi
```

4. Clonse Base Model and Create RAMP_HOME
4. Clone Base Model and Create RAMP_HOME

- Create a new folder called RAMP , outside fAIr

Expand Down Expand Up @@ -72,7 +72,8 @@ Docker Compose is created with redis , worker , postgis database , api and fron
- Check permissions for ```Read user preferences``` and Redirect URI to be ```http://127.0.0.1:3000/authenticate/``` , Give it name as ```fAIr Dev Local```
- You will get ```OSM_CLIENT_ID``` , ```OSM_CLIENT_SECRET``` Copy them

6. Create Env variables
6. Create Env variables
Backend
- Create a file ```.env``` in backend with [docker_sample_env](../backend/docker_sample_env) content
```
cd backend
Expand All @@ -82,14 +83,15 @@ Docker Compose is created with redis , worker , postgis database , api and fron

Leave rest of the items as it is unless you know what you are doing

- Create ```.env``` in /frontend
Frontend
- Create ```.env``` file in /frontend
```
cd frontend
cp .env_sample .env
```
You can leave it as it is for dev setup

7. Build & Run containers
8. Build & Run containers

```
docker compose build
Expand All @@ -99,7 +101,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron
docker compose up
```

8. Run Migrations
9. Run Migrations

Run directly bash script :

Expand All @@ -121,7 +123,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron
python manage.py makemigrations core
python manage.py migrate

9. Play and Develop
10. Play and Develop

Restart containers

Expand All @@ -133,7 +135,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron

Please open the frontend using URL `127.0.0.1:3000` instead of `localhost:3000` to ensure login functionality.

10. Want to run your local tiles ?
11. Want to run your local tiles ?

You can use [titler](https://github.com/developmentseed/titiler) , [gdals2tiles](https://gdal.org/programs/gdal2tiles.html) or nginx to run your own TMS server and add following to docker compose in order to access your localhost through docker containers . Add those to API and Worker . Make sure you update the .env variable accordingly

Expand Down Expand Up @@ -185,4 +187,4 @@ Docker Compose is created with redis , worker , postgis database , api and fron
DATABASE_URL=postgis://postgres:admin@localhost:5434/ai
CELERY_BROKER_URL="redis://localhost:6379/0"
CELERY_RESULT_BACKEND="redis://localhost:6379/0"
```
```
29 changes: 29 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,32 @@ A : Absolutely! The fAIr project welcomes contributions related to new AI models
**Q : What kind of support can I expect as a developer contributing to fAIr?**

A : As a developer contributing to fAIr, you can receive support and guidance from the project maintainers and the community. The maintainers can help address technical questions, review your contributions, and provide feedback. The community also offers a collaborative environment where you can interact with other contributors and share knowledge.

## Community Managers
**Q : Why can I only map buildings?**

A : fAIr currently only works with buildings. We are hoping in the future to expand to other feature types.

<hr>

**Q : Can we edit with JSON in fAir?**

A : Yes, that option is now available.

<hr>

**Q : If I map the same area but in another editor, will fAIr take into account this data?**

A : Regardless of which editing tool you use, once it goes into OSM, it will be taken into fAIr as long as you click “fetch OSM” after they map

<hr>

**Q : If I map a little outside the task, selected AOI, is the data also fed into fAIr? Or is it ignored?**

A : Anything that intersects with the AOI boundary is needed and will be counted in fAIr training data, buildings fully outside the boundary won’t be counted for training dataset but they are already in OSM

<hr>

**Q : I don’t remember what to do when I’m finished, just “fetch”?**

A : Yes, after mapping the selected AOI, you should come back to fAIr and fetch so you will see them in fAIr.