Loading atlas with no Internet

[saarah815]

Before submitting a pull request (PR), please read the contributing guide.

Please fill out as much of this template as you can, but if you have any problems or questions, just leave a comment and we will help out :)

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?

Outputs appropriate error messages when user tries to load atlas with no Internet connection.

What does this PR do?

In bg_atlas.BrainGlobeAtlas:

• utils.check_internet_connection() checks for Internet connection, and also checks if GIN is down. If there is no Internet connection, code checks to see if the atlas they want is cached and available locally. If so, continues as normal.
• If atlas unavailable locally, code tells user to connect to the Internet in order to download the atlas.

In list_atlases.get_all_atlases_lastversions():

• utils.check_internet_connection() checks for Internet connection, and also checks if GIN is down. If there is an Internet connection, get_all_atlases_lastversions() performs as before and returns the updated list of available atlases from last_versions.conf from GIN.
• If there is no Internet, get_all_atlases_lastversions() warns user that they are offline. If user has a local copy of last_versions.conf in /.brainglobe/, get_all_atlases_lastversions() will call a new function utils.conf_from_file to return the list of available atlases based on this local conf file, but will also warn the user that this list could be outdated and that they should connect to the Internet for an updated list.
• If the user does not have a local copy of last_versions.conf in /.brainglobe/, get_all_atlases_lastversions() will tell user that they must connect to the Internet to fetch atlas list.

References

Issue #142

How has this PR been tested?

Tested locally with different situations:

In bg_atlas.BrainGlobeAtlas:

• No Internet but atlas exists locally:

• No Internet and does not exist locally:

• Connected to the Internet and exists locally:

[Works as expected, no output]

• Connected to the Internet, but does not exist locally:

In get_all_atlases_lastversions():

• No Internet and last_versions.conf does not exist in local /.brainglobe/:

• No Internet and last_versions.conf does exist in local /.brainglobe/ (but could be outdated):

(Note: I am explicitly printing the list here)

• Connected to the Internet:

(Works as expected and gets last_versions.conf from GIN with no error messages. Again, I am explicitly printing the list here)

Is this a breaking change?

No.

Does this PR require an update to the documentation?

N/A

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality (unit & integration)
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[IgorTatarnikov]

This is great! I'll do a bit of refactoring and get this reviewed.

[IgorTatarnikov]

This should cover everything.

The last_versions.conf file should now be cached to disk (in the brainglobe directory as defined by the config) every time it's fetched from GIN. If the internet/GIN is down, this local cached copy can be used to display the available atlaes.

Errors and warnings should now separate when the internet is not available vs when GIN itself is down.

[alessandrofelder]

very nice.