https://github.com/antononcube/raku-dsl-entity-geographics
Raku package with grammars for geographic entities.
https://github.com/antononcube/raku-dsl-entity-geographics
geographic-data grammar-parser named-entity-recognition raku
Last synced: 6 months ago
JSON representation
Raku package with grammars for geographic entities.
- Host: GitHub
- URL: https://github.com/antononcube/raku-dsl-entity-geographics
- Owner: antononcube
- License: artistic-2.0
- Created: 2021-03-14T13:31:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T14:15:15.000Z (over 1 year ago)
- Last Synced: 2025-02-08T11:13:07.789Z (8 months ago)
- Topics: geographic-data, grammar-parser, named-entity-recognition, raku
- Language: Raku
- Homepage: https://raku.land/zef:antononcube/DSL::Entity::Geographics
- Size: 856 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-work.md
- License: LICENSE
Awesome Lists containing this project
README
# DSL::Entity::Geographics
[](https://github.com/antononcube/Raku-DSL-Entity-Geographics/actions/workflows/macos.yml)
[](https://github.com/antononcube/Raku-DSL-Entity-Geographics/actions/workflows/linux.yml)
[](https://github.com/antononcube/Raku-DSL-Entity-Geographics/actions/workflows/windows.yml)
[](https://raku.land/zef:antononcube/DSL::Entity::Geographics)
[](https://opensource.org/licenses/Artistic-2.0)
Raku grammar classes for geographic entities (names.)
This package is closely related, but independent of
[Data::Geographics](https://raku.land/zef:antononcube/Data::Geographics), [AAp5].
## Installation
From [Zef ecosystem](https://raku.land):
```
zef install DSL::Entity::Geographics
```
From GitHub:
```
zef install https://github.com/antononcube/Raku-DSL-Entity-Geographics.git
```
## Examples
### Basic entity name retrieval
Here we show how the entity ID is retrieved using an adjective:
```perl6
use DSL::Entity::Geographics;
ToGeographicEntityCode('Brazilian');
```
### Identifiers
The known cities are have identifier in the form: `..`.
The names in the identifiers have underscore characters ("_") instead of spaces.
For example:
```
United_States.Nevada.Las_Vegas
```
**Remark:** Both packages "DSL::Entity::Geographics" and "Data::Geographics" have
the same identifiers.
### City specs
There is a dedicated function for parsing city names together with a state- or country name:
```perl6
entity-city-and-state-name('Chicago, IL')
```
If the adverb `:exhaustive` (or just `:ex`) is used then all matches for city name in country (like USA)
are returned:
```perl6
.say for entity-city-and-state-name('Atlanta United States'):ex
```
A city name without a specified country or state is considered a generic city name if found in the
gazeteer database:
```perl6
say entity-city-and-state-name('Miama');
```
**Remark:** Misspellings are recognized and allowed:
### Grammar parsing
One of the main motivations for this package is to be able to use known country names and related adjectives
as grammar tokens. For example, in packages like ["DSL::English::FoodPreparationWorkflows"](https://github.com/antononcube/Raku-DSL-English-FoodPreparationWorkflows), [AAp4].
Here are few grammar parsing examples:
```perl6
use DSL::Entity::Geographics::Grammar;
my $pCOMMAND = DSL::Entity::Geographics::Grammar.new;
$pCOMMAND.set-resources(DSL::Entity::Geographics::resource-access-object());
say $pCOMMAND.parse('Argentina', rule => 'geographic-entity-command');
```
```perl6
say $pCOMMAND.parse('United States of America', rule => 'geographic-entity-command');
```
Again, misspellings are recognized and allowed:
```perl6
say $pCOMMAND.parse('Indianapolia, Indiana', rule => 'entity-city-and-state-name');
```
## References
[AAp1] Anton Antonov,
[DSL::Shared Raku package](https://github.com/antononcube/Raku-DSL-Shared),
(2020),
[GitHub/antononcube](https://github.com/antononcube).
[AAp2] Anton Antonov,
[DSL::Entity::Jobs Raku package](https://github.com/antononcube/Raku-DSL-Entity-Jobs),
(2021),
[GitHub/antononcube](https://github.com/antononcube).
[AAp3] Anton Antonov,
[DSL::Entity::Foods Raku package](https://github.com/antononcube/Raku-DSL-Entity-Foods),
(2021),
[GitHub/antononcube](https://github.com/antononcube).
[AAp4] Anton Antonov,
[DSL::English::FoodPreparationWorkflows Raku package](https://github.com/antononcube/Raku-DSL-English-FoodPreparationWorkflows),
(2021),
[GitHub/antononcube](https://github.com/antononcube).
[AAp5] Anton Antonov,
[Data::Geographics Raku package](https://github.com/antononcube/Raku-Data-Geographics),
(2024),
[GitHub/antononcube](https://github.com/antononcube).